Objects - Charter Docs

Model tree

SubscriptionItemCreate

SubscriptionPriceData

PriceRecurring

SubscriptionDiscount

SubscriptionItemUpdate

SubscriptionPriceData above

SubscriptionDiscount

CancellationDetails

SubscriptionItemCreate

One item on a new subscription.

Field	Type	Description
`price`	`string`	The ID of the price object.
`priceData`	SubscriptionPriceData	An inline price, instead of naming an existing one.
`quantity`	`integer`	How many of this price the subscription covers. ≥ 0
`metadata`	map of `string`	Set of key-value pairs attached to this item.
`taxRates`	`string`[]	Tax rate IDs overriding the subscription’s default_tax_rates for this item.
`discounts`	SubscriptionDiscount[]	Discounts applying to this item alone.

SubscriptionPriceData

An inline price, created with the subscription rather than looked up.

Field	Type	Description
`currency` *	`string`	Three-letter lowercase ISO currency code.
`product` *	`string`	The ID of the product this price is for.
`recurring` *	PriceRecurring	The billing interval.
`unitAmount`	`integer`	A positive integer in the smallest currency unit. Mutually exclusive with unit_amount_decimal. Cents, not dollars: $15.00 is 1500, and 15 charges fifteen cents each period. Multiply a decimal amount by 100.
`unitAmountDecimal`	`string`	Same as `unit_amount`, but accepts a decimal value in the smallest currency unit with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. Cents, not dollars: $15.00 is “1500”. The decimal places are fractions of a cent, so “1500.5” is fifteen dollars and half a cent.
`taxBehavior`	PriceTaxBehavior	Whether the price is considered inclusive or exclusive of taxes. Stripe recommends setting this if you calculate taxes.

PriceRecurring

How often an inline price bills.

Field	Type	Description
`interval` *	RecurringInterval	The billing frequency: day, week, month or year.
`intervalCount`	`integer`	The number of intervals between billings. Absent, Stripe bills once per interval. ≥ 1

SubscriptionDiscount

One discount, on the subscription or on a single item.

Field	Type	Description
`coupon`	`string`	The ID of a coupon to apply.
`discount`	`string`	The ID of an existing discount to reuse.
`promotionCode`	`string`	The ID of a promotion code to apply.

SubscriptionItemUpdate

One item on an existing subscription.

Field	Type	Description
`price`	`string`	The ID of the price object.
`priceData`	SubscriptionPriceData	An inline price, instead of naming an existing one.
`quantity`	`integer`	How many of this price the subscription covers. ≥ 0
`metadata`	map of `string`	Set of key-value pairs attached to this item.
`taxRates`	`string`[]	Tax rate IDs overriding the subscription’s default_tax_rates for this item.
`discounts`	SubscriptionDiscount[]	Discounts applying to this item alone.
`id`	`string`	The ID of the subscription item to modify. Omit it and Stripe adds a new item instead of updating an existing one.
`deleted`	`boolean`	Set true to remove this item from the subscription.
`clearUsage`	`boolean`	Whether to reset the billing period’s usage. Required when deleting an item that records usage. No effect when the plan has a billing meter.

CancellationDetails

Why the subscription was cancelled.

Field	Type	Description
`comment`	`string`	A free-text comment, if the customer gave one.
`feedback`	CancellationFeedback	The customer-submitted reason, from Stripe’s fixed set.
`feedbackOption`	`string`	A customised feedback option, for more detail than the enum.

RecurringInterval

Value
`day`
`week`
`month`
`year`

CollectionMethod

Value
`charge_automatically`
`send_invoice`

CancelAtSentinel

Value
`max_billed_until`
`max_period_end`
`min_period_end`

CancellationFeedback

Value
`customer_service`
`low_quality`
`missing_features`
`other`
`switched_service`
`too_complex`
`too_expensive`
`unused`

ProrationBehaviorOnCreate

Value
`create_prorations`
`none`

ProrationBehaviorOnUpdate

Value
`always_invoice`
`create_prorations`
`none`

PaymentBehaviorOnCreate

Value
`allow_incomplete`
`default_incomplete`
`error_if_incomplete`

PaymentBehaviorOnUpdate

Value
`allow_incomplete`
`default_incomplete`
`error_if_incomplete`
`pending_if_incomplete`

​Model tree

​SubscriptionItemCreate

​SubscriptionPriceData

​PriceRecurring

​SubscriptionDiscount

​SubscriptionItemUpdate

​CancellationDetails

​RecurringInterval

​CollectionMethod

​CancelAtSentinel

​CancellationFeedback

​ProrationBehaviorOnCreate

​ProrationBehaviorOnUpdate

​PaymentBehaviorOnCreate

​PaymentBehaviorOnUpdate

Model tree

SubscriptionItemCreate

SubscriptionPriceData

PriceRecurring

SubscriptionDiscount

SubscriptionItemUpdate

CancellationDetails

RecurringInterval

CollectionMethod

CancelAtSentinel

CancellationFeedback

ProrationBehaviorOnCreate

ProrationBehaviorOnUpdate

PaymentBehaviorOnCreate

PaymentBehaviorOnUpdate