Interface Subscription

Export

Subscription

Hierarchy

  • Subscription

Properties

account_id: string

The id of the associated account.

Memberof

Subscription

billing_cycle_anchor: string

Determines the date of the first payment and the day of week/month/year for subsequent payments. If a month doesn't have the anchor day, the subscription will be billed on the last day of the month. For example, a monthly subscription starting on January 31 bills on Feb 28/29, then March 31, April 30, etc. The subscription will be billed close to (typically within 30 minutes) the time portion of this date-time field. Note: if no time portion was specified during the creation of the subscription (i.e. '2022-04-01') then the time is defaulted to midnight UTC (00:00:00) and the subscription will be billed around 7PM Eastern on the previous day.

Memberof

Subscription

cancel_at?: string

A date in the future at which the subscription will automatically get canceled.

Memberof

Subscription

canceled_at?: string

If the subscription has been canceled, the date of that cancellation.

Memberof

Subscription

created_at: string

Time at which the object was created.

Memberof

Subscription

Three-letter ISO currency code, in lowercase.

Memberof

Subscription

customer_id: string

The id of the customer who owns the subscription.

Memberof

Subscription

id: string

Unique identifier for the object.

Memberof

Subscription

interval_count: number

The number of intervals (specified in the interval_unit attribute) between subscription billings. For example, interval_unit=month and interval_count=3 bills every 3 months.

Memberof

Subscription

The frequency at which a subscription is billed. One of week, month or year.

Memberof

Subscription

metadata?: {
    [key: string]: string;
}

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. This metadata will be copied to the payment_intent.metadata field when a payment is attempted.

Memberof

Subscription

Type declaration

  • [key: string]: string
next_payment_at?: string

The date at which payment will next be attempted. The value will be null when no more payments are to be attempted. Examples: canceled and paused statuses or cancel_at is prior to what would be the next payment date. When a payment fails and the status changes to past_due this value can be manually updated to determine the next attempt.

Memberof

Subscription

pause_at?: string

A date in the future at which the subscription will automatically get paused.

Memberof

Subscription

paused_at?: string

If the subscription has been paused, the date of the most recent pausing.

Memberof

Subscription

payment_method_id: string

The id of the PaymentMethod used for this subscription. It must belong to the customer associated with the subscription.

Memberof

Subscription

platform_fee_amount?: number

The amount of the fee (if any) that will be requested to be applied to the payment and transferred to the partner account. The amount of the fee collected will be capped a the total payment amount.

Memberof

Subscription

price: number

Amount intended to be collected by this subscription. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).

Memberof

Subscription

resume_at?: string

If the subscription has been paused, the date in the future at which the subscription will automatically return to active.

Memberof

Subscription

Status of this subscription, one of active, canceled, past_due, paused, or pending.

Memberof

Subscription

updated_at: string

Time at which the object was last updated.

Memberof

Subscription

Generated using TypeDoc