BillingSubscriptionCreate

object

Subscription create request.

labelsobject

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"}

customerobjectrequired

The customer to create the subscription for.

Show Child Parameters
planobjectrequired

The plan reference of the subscription.

Show Child Parameters
billing_anchorstring(date-time)

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

Example

BillingSubscriptionEditTimingEnum

string

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

BillingWorkflowCollectionAlignmentAnchored

object

BillingWorkflowCollectionAlignmentAnchored specifies the alignment for collecting the pending line items
into an invoice.

typestringrequired

The type of alignment.

Allowed values:anchored

recurring_periodobjectrequired

The recurring period for the alignment.

Show Child Parameters
Example

BillingWorkflowCollectionAlignmentSubscription

object

BillingWorkflowCollectionAlignmentSubscription specifies the alignment for collecting the pending line items
into an invoice.

typestringrequired

The type of alignment.

Allowed values:subscription

Example

BillingWorkflowPaymentChargeAutomaticallySettings

object

Payment settings for a billing workflow when the collection method is charge automatically.

collection_methodstringrequired

The collection method for the invoice.

Allowed values:charge_automatically

Example