BillingSubscription
objectSubscription.
ULID (Universally Unique Lexicographically Sortable Identifier).
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2023-01-01T01:01:01.001Z
An ISO-8601 timestamp representation of entity last update date.
Example:2023-01-01T01:01:01.001Z
An ISO-8601 timestamp representation of entity deletion date.
Example:2023-01-01T01:01:01.001Z
The customer ID of the subscription.
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
The plan ID of the subscription.
Set if subscription is created from a plan.
Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:01G65Z755AFWAKHE12NY0CQ9FH
A billing anchor is the fixed point in time that determines the subscription’s recurring billing cycle.
It affects when charges occur and how prorations are calculated.
Common anchors:
- Calendar month (1st of each month):
2025-01-01T00:00:00Z - Subscription anniversary (day customer signed up)
- Custom date (customer-specified day)
Example:2023-01-01T01:01:01.001Z
The status of the subscription.
Allowed values:activeinactivecanceledscheduled
BillingSubscriptionCancel
objectRequest for canceling a subscription.
One OfIf not provided the subscription is canceled immediately.
Default:immediate
Example:immediate
Subscription edit timing.
When immediate, the requested changes take effect immediately.
When next_billing_cycle, the requested changes take effect at the next billing cycle.
Allowed values:immediatenext_billing_cycle
BillingSubscriptionChange
objectRequest for changing a subscription.
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
The customer to create the subscription for.
Show Child Parameters
The plan reference of the subscription.
Show Child Parameters
A billing anchor is the fixed point in time that determines the subscription’s recurring billing cycle.
It affects when charges occur and how prorations are calculated.
Common anchors:
- Calendar month (1st of each month):
2025-01-01T00:00:00Z - Subscription anniversary (day customer signed up)
- Custom date (customer-specified day)
If not provided, the subscription will be created with the subscription’s creation time as the billing anchor.
Example:2023-01-01T01:01:01.001Z
One OfTiming configuration for the change, when the change should take effect.
For changing a subscription, the accepted values depend on the subscription configuration.
Example:immediate
Subscription edit timing.
When immediate, the requested changes take effect immediately.
When next_billing_cycle, the requested changes take effect at the next billing cycle.
Allowed values:immediatenext_billing_cycle
BillingSubscriptionChangeResponse
objectResponse for changing a subscription.
The current subscription before the change.
Show Child Parameters
The new state of the subscription after the change.
Show Child Parameters
BillingSubscriptionCreate
objectSubscription create request.
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
The customer to create the subscription for.
Show Child Parameters
The plan reference of the subscription.
Show Child Parameters
A billing anchor is the fixed point in time that determines the subscription’s recurring billing cycle.
It affects when charges occur and how prorations are calculated.
Common anchors:
- Calendar month (1st of each month):
2025-01-01T00:00:00Z - Subscription anniversary (day customer signed up)
- Custom date (customer-specified day)
If not provided, the subscription will be created with the subscription’s creation time as the billing anchor.
Example:2023-01-01T01:01:01.001Z