Metering Event

object

Metering event following the CloudEvents specification.

idstringrequired

Identifies the event.

>= 1 characters

Example:5c10fade-1c9e-4d6c-8275-c52c36731d3c

sourcestring(uri-reference)required

Identifies the context in which an event happened.

>= 1 characters

Example:service-name

specversionstringrequired

The version of the CloudEvents specification which the event uses.

Default:1.0

>= 1 characters

Example:1.0

typestringrequired

Contains a value describing the type of event related to the originating occurrence.

>= 1 characters

Example:com.example.someevent

datacontenttypestring

Content type of the CloudEvents data value. Only the value “application/json” is allowed over HTTP.

Allowed values:application/json

Example:application/json

dataschemastring(uri)

Identifies the schema that data adheres to.

>= 1 characters

subjectstringrequired

Describes the subject of the event in the context of the event producer (identified by source).

>= 1 characters

Example:customer-id

timestring(date-time)

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

Example:2023-01-01T01:01:01.001Z

dataobject

The event payload.
Optional, if present it must be a JSON object.

Example

Resource Key

string

A key is a unique string that is used to identify a resource.

Match pattern:^[a-z0-9]+(?:_[a-z0-9]+)*$

>= 1 characters<= 64 characters

Example

SubscriptionPagePaginatedResponse

object

Page paginated response.

dataarray[object]required

Subscription.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

ULID

string

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example

UpsertAppCustomerDataRequest

object

AppCustomerData upsert request.

stripeobject

Used if the customer has a linked Stripe app.

Show Child Parameters
external_invoicingobject

Used if the customer has a linked external invoicing app.

Show Child Parameters
Example