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
BillingSubscriptionEditTimingEnum
stringSubscription 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
BillingWorkflowCollectionAlignmentAnchored
objectBillingWorkflowCollectionAlignmentAnchored specifies the alignment for collecting the pending line items
into an invoice.
The type of alignment.
Allowed values:anchored
The recurring period for the alignment.
Show Child Parameters
BillingWorkflowCollectionAlignmentSubscription
objectBillingWorkflowCollectionAlignmentSubscription specifies the alignment for collecting the pending line items
into an invoice.
The type of alignment.
Allowed values:subscription
BillingWorkflowPaymentChargeAutomaticallySettings
objectPayment settings for a billing workflow when the collection method is charge automatically.
The collection method for the invoice.
Allowed values:charge_automatically