stripe
Version:
Stripe API wrapper
825 lines • 126 kB
TypeScript
import { StripeResource } from '../StripeResource.js';
import { DeletedDiscount, Discount } from './Discounts.js';
import { Application, DeletedApplication } from './Applications.js';
import { Customer, DeletedCustomer } from './Customers.js';
import { PaymentMethod } from './PaymentMethods.js';
import { CustomerSource } from './CustomerSources.js';
import { TaxRate } from './TaxRates.js';
import { SubscriptionItem } from './SubscriptionItems.js';
import { Invoice } from './Invoices.js';
import { Account } from './Accounts.js';
import { SetupIntent } from './SetupIntents.js';
import { SubscriptionSchedule } from './SubscriptionSchedules.js';
import { TaxId, DeletedTaxId } from './TaxIds.js';
import * as TestHelpers from './TestHelpers/index.js';
import { Emptyable, MetadataParam, Decimal, PaginationParams, RangeQueryParam, Metadata } from '../shared.js';
import { RequestOptions, Response, ApiListPromise, ApiList, ApiSearchResultPromise } from '../lib.js';
export declare class SubscriptionResource extends StripeResource {
/**
* Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
*
* Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api/invoiceitems/delete). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
*
* By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
*/
cancel(id: string, params?: SubscriptionCancelParams, options?: RequestOptions): Promise<Response<Subscription>>;
/**
* Retrieves the subscription with the given ID.
*/
retrieve(id: string, params?: SubscriptionRetrieveParams, options?: RequestOptions): Promise<Response<Subscription>>;
/**
* Updates an existing subscription to match the specified parameters.
* When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
* To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint.
*
* By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
*
* Switching prices does not normally change the billing date or generate an immediate charge unless:
*
*
* The billing interval is changed (for example, from monthly to yearly).
* The subscription moves from free to paid.
* A trial starts or ends.
*
*
* In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment).
*
* If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create).
*
* If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
*
* Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing](https://docs.stripe.com/docs/rate-limits) instead.
*/
update(id: string, params?: SubscriptionUpdateParams, options?: RequestOptions): Promise<Response<Subscription>>;
/**
* Removes the currently applied discount on a subscription.
*/
deleteDiscount(id: string, params?: SubscriptionDeleteDiscountParams, options?: RequestOptions): Promise<Response<DeletedDiscount>>;
/**
* By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
*/
list(params?: SubscriptionListParams, options?: RequestOptions): ApiListPromise<Subscription>;
/**
* Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
*
* When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
* The payment_behavior parameter determines the exact behavior of the initial payment.
*
* To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead.
* Schedules provide the flexibility to model more complex billing configurations that change over time.
*/
create(params?: SubscriptionCreateParams, options?: RequestOptions): Promise<Response<Subscription>>;
/**
* Search for subscriptions you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
* Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
* conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
* to an hour behind during outages. Search functionality is not available to merchants in India.
*/
search(params: SubscriptionSearchParams, options?: RequestOptions): ApiSearchResultPromise<Subscription>;
/**
* Upgrade the billing_mode of an existing subscription.
*/
migrate(id: string, params: SubscriptionMigrateParams, options?: RequestOptions): Promise<Response<Subscription>>;
/**
* Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused.
*/
resume(id: string, params?: SubscriptionResumeParams, options?: RequestOptions): Promise<Response<Subscription>>;
}
export interface Subscription {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'subscription';
/**
* ID of the Connect Application that created the subscription.
*/
application: string | Application | DeletedApplication | null;
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
*/
application_fee_percent: number | null;
automatic_tax: Subscription.AutomaticTax;
/**
* The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
*/
billing_cycle_anchor: number;
/**
* The fixed values used to calculate the `billing_cycle_anchor`.
*/
billing_cycle_anchor_config: Subscription.BillingCycleAnchorConfig | null;
/**
* The billing mode of the subscription.
*/
billing_mode: Subscription.BillingMode;
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
*/
billing_thresholds: Subscription.BillingThresholds | null;
/**
* A date in the future at which the subscription will automatically get canceled
*/
cancel_at: number | null;
/**
* Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.
*/
cancel_at_period_end: boolean;
/**
* If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
*/
canceled_at: number | null;
/**
* Details about why this subscription was cancelled
*/
cancellation_details: Subscription.CancellationDetails | null;
/**
* Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
*/
collection_method: Subscription.CollectionMethod;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
created: number;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
currency: string;
/**
* ID of the customer who owns the subscription.
*/
customer: string | Customer | DeletedCustomer;
/**
* ID of the account representing the customer who owns the subscription.
*/
customer_account: string | null;
/**
* Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
*/
days_until_due: number | null;
/**
* ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
*/
default_payment_method: string | PaymentMethod | null;
/**
* ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
*/
default_source: string | CustomerSource | null;
/**
* The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
*/
default_tax_rates?: Array<TaxRate> | null;
/**
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
*/
description: string | null;
/**
* The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.
*/
discounts: Array<string | Discount>;
/**
* If the subscription has ended, the date the subscription ended.
*/
ended_at: number | null;
invoice_settings: Subscription.InvoiceSettings;
/**
* List of subscription items, each with an attached price.
*/
items: ApiList<SubscriptionItem>;
/**
* The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated).
*/
latest_invoice: string | Invoice | null;
/**
* If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
*/
livemode: boolean;
/**
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
*/
metadata: Metadata;
/**
* Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
*/
next_pending_invoice_item_invoice: number | null;
/**
* The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) for details.
*/
on_behalf_of: string | Account | null;
/**
* If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
*/
pause_collection: Subscription.PauseCollection | null;
/**
* Payment settings passed on to invoices created by the subscription.
*/
payment_settings: Subscription.PaymentSettings | null;
/**
* Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api/invoices/create) for the given subscription at the specified interval.
*/
pending_invoice_item_interval: Subscription.PendingInvoiceItemInterval | null;
/**
* You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2).
*/
pending_setup_intent: string | SetupIntent | null;
/**
* If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
*/
pending_update: Subscription.PendingUpdate | null;
presentment_details?: Subscription.PresentmentDetails;
/**
* The schedule attached to the subscription
*/
schedule: string | SubscriptionSchedule | null;
/**
* Date when the subscription was first created. The date might differ from the `created` date due to backdating.
*/
start_date: number;
/**
* Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`.
*
* For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated.
*
* A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over.
*
* A subscription can only enter a `paused` status [when a trial ends without a payment method](https://docs.stripe.com/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged.
*
* If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings).
*
* If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
*/
status: Subscription.Status;
/**
* ID of the test clock this subscription belongs to.
*/
test_clock: string | TestHelpers.TestClock | null;
/**
* The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
*/
transfer_data: Subscription.TransferData | null;
/**
* If the subscription has a trial, the end of that trial.
*/
trial_end: number | null;
/**
* Settings related to subscription trials.
*/
trial_settings: Subscription.TrialSettings | null;
/**
* If the subscription has a trial, the beginning of that trial.
*/
trial_start: number | null;
}
export declare namespace Subscription {
interface AutomaticTax {
/**
* If Stripe disabled automatic tax, this enum describes why.
*/
disabled_reason: 'requires_location_inputs' | null;
/**
* Whether Stripe automatically computes tax on this subscription.
*/
enabled: boolean;
/**
* The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
*/
liability: AutomaticTax.Liability | null;
}
interface BillingCycleAnchorConfig {
/**
* The day of the month of the billing_cycle_anchor.
*/
day_of_month: number;
/**
* The hour of the day of the billing_cycle_anchor.
*/
hour: number | null;
/**
* The minute of the hour of the billing_cycle_anchor.
*/
minute: number | null;
/**
* The month to start full cycle billing periods.
*/
month: number | null;
/**
* The second of the minute of the billing_cycle_anchor.
*/
second: number | null;
}
interface BillingMode {
/**
* Configure behavior for flexible billing mode
*/
flexible: BillingMode.Flexible | null;
/**
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
*/
type: BillingMode.Type;
/**
* Details on when the current billing_mode was adopted.
*/
updated_at?: number;
}
interface BillingThresholds {
/**
* Monetary threshold that triggers the subscription to create an invoice
*/
amount_gte: number | null;
/**
* Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.
*/
reset_billing_cycle_anchor: boolean | null;
}
interface CancellationDetails {
/**
* Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
*/
comment: string | null;
/**
* The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
*/
feedback: CancellationDetails.Feedback | null;
/**
* Why this subscription was canceled.
*/
reason: CancellationDetails.Reason | null;
}
type CollectionMethod = 'charge_automatically' | 'send_invoice';
interface InvoiceSettings {
/**
* The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
*/
account_tax_ids: Array<string | TaxId | DeletedTaxId> | null;
issuer: InvoiceSettings.Issuer;
}
interface PauseCollection {
/**
* The payment collection behavior for this subscription while paused.
*/
behavior: PauseCollection.Behavior;
/**
* The time after which the subscription will resume collecting payments.
*/
resumes_at: number | null;
}
interface PaymentSettings {
/**
* Payment-method-specific configuration to provide to invoices created by the subscription.
*/
payment_method_options: PaymentSettings.PaymentMethodOptions | null;
/**
* The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
*/
payment_method_types: Array<PaymentSettings.PaymentMethodType> | null;
/**
* Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.
*/
save_default_payment_method: PaymentSettings.SaveDefaultPaymentMethod | null;
}
interface PendingInvoiceItemInterval {
/**
* Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: PendingInvoiceItemInterval.Interval;
/**
* The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
*/
interval_count: number;
}
interface PendingUpdate {
/**
* If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
*/
billing_cycle_anchor: number | null;
/**
* The point after which the changes reflected by this update will be discarded and no longer applied.
*/
expires_at: number;
/**
* List of subscription items, each with an attached plan, that will be set if the update is applied.
*/
subscription_items: Array<SubscriptionItem> | null;
/**
* Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
*/
trial_end: number | null;
/**
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more.
*/
trial_from_plan: boolean | null;
}
interface PresentmentDetails {
/**
* Currency used for customer payments.
*/
presentment_currency: string;
}
type Status = 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'paused' | 'trialing' | 'unpaid';
interface TransferData {
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
*/
amount_percent: number | null;
/**
* The account where funds from the payment will be transferred to upon payment success.
*/
destination: string | Account;
}
interface TrialSettings {
/**
* Defines how a subscription behaves when a trial ends.
*/
end_behavior: TrialSettings.EndBehavior;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string | Account;
/**
* Type of the account referenced.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
}
namespace BillingMode {
interface Flexible {
/**
* Controls how invoices and invoice items display proration amounts and discount amounts.
*/
proration_discounts?: Flexible.ProrationDiscounts;
}
type Type = 'classic' | 'flexible';
namespace Flexible {
type ProrationDiscounts = 'included' | 'itemized';
}
}
namespace CancellationDetails {
type Feedback = 'customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused';
type Reason = 'canceled_by_retention_policy' | 'cancellation_requested' | 'payment_disputed' | 'payment_failed';
}
namespace InvoiceSettings {
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string | Account;
/**
* Type of the account referenced.
*/
type: Issuer.Type;
}
namespace Issuer {
type Type = 'account' | 'self';
}
}
namespace PauseCollection {
type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
}
namespace PaymentSettings {
interface PaymentMethodOptions {
/**
* This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
*/
acss_debit: PaymentMethodOptions.AcssDebit | null;
/**
* This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
*/
bancontact: PaymentMethodOptions.Bancontact | null;
/**
* This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
*/
card: PaymentMethodOptions.Card | null;
/**
* This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
*/
customer_balance: PaymentMethodOptions.CustomerBalance | null;
/**
* This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
*/
konbini: PaymentMethodOptions.Konbini | null;
/**
* This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription.
*/
payto: PaymentMethodOptions.Payto | null;
/**
* This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.
*/
sepa_debit: PaymentMethodOptions.SepaDebit | null;
/**
* This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
*/
us_bank_account: PaymentMethodOptions.UsBankAccount | null;
}
type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'us_bank_account' | 'wechat_pay';
type SaveDefaultPaymentMethod = 'off' | 'on_subscription';
namespace PaymentMethodOptions {
interface AcssDebit {
mandate_options?: AcssDebit.MandateOptions;
/**
* Bank account verification method. The default value is `automatic`.
*/
verification_method?: AcssDebit.VerificationMethod;
}
interface Bancontact {
/**
* Preferred language of the Bancontact authorization page that the customer is redirected to.
*/
preferred_language: Bancontact.PreferredLanguage;
}
interface Card {
mandate_options?: Card.MandateOptions;
/**
* Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
*/
network: Card.Network | null;
/**
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
*/
request_three_d_secure: Card.RequestThreeDSecure | null;
}
interface CustomerBalance {
bank_transfer?: CustomerBalance.BankTransfer;
/**
* The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
*/
funding_type: 'bank_transfer' | null;
}
interface Konbini {
}
interface Payto {
mandate_options?: Payto.MandateOptions;
}
interface SepaDebit {
}
interface UsBankAccount {
financial_connections?: UsBankAccount.FinancialConnections;
/**
* Bank account verification method. The default value is `automatic`.
*/
verification_method?: UsBankAccount.VerificationMethod;
}
namespace AcssDebit {
interface MandateOptions {
/**
* Transaction type of the mandate.
*/
transaction_type: MandateOptions.TransactionType | null;
}
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
namespace MandateOptions {
type TransactionType = 'business' | 'personal';
}
}
namespace Bancontact {
type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
}
namespace Card {
interface MandateOptions {
/**
* Amount to be charged for future payments, specified in the presentment currency.
*/
amount: number | null;
/**
* One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
*/
amount_type: MandateOptions.AmountType | null;
/**
* A description of the mandate or subscription that is meant to be displayed to the customer.
*/
description: string | null;
}
type Network = 'amex' | 'cartes_bancaires' | 'diners' | 'discover' | 'eftpos_au' | 'girocard' | 'interac' | 'jcb' | 'link' | 'mastercard' | 'unionpay' | 'unknown' | 'visa';
type RequestThreeDSecure = 'any' | 'automatic' | 'challenge';
namespace MandateOptions {
type AmountType = 'fixed' | 'maximum';
}
}
namespace CustomerBalance {
interface BankTransfer {
eu_bank_transfer?: BankTransfer.EuBankTransfer;
/**
* The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
*/
type: string | null;
}
namespace BankTransfer {
interface EuBankTransfer {
/**
* The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`.
*/
country: EuBankTransfer.Country;
}
namespace EuBankTransfer {
type Country = 'BE' | 'DE' | 'ES' | 'FR' | 'IE' | 'NL';
}
}
}
namespace Payto {
interface MandateOptions {
/**
* The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
*/
amount: number | null;
/**
* Only `maximum` is supported.
*/
amount_type: MandateOptions.AmountType | null;
/**
* The purpose for which payments are made. Has a default value based on your merchant category code.
*/
purpose: MandateOptions.Purpose | null;
}
namespace MandateOptions {
type AmountType = 'fixed' | 'maximum';
type Purpose = 'dependant_support' | 'government' | 'loan' | 'mortgage' | 'other' | 'pension' | 'personal' | 'retail' | 'salary' | 'tax' | 'utility';
}
}
namespace UsBankAccount {
interface FinancialConnections {
filters?: FinancialConnections.Filters;
/**
* The list of permissions to request. The `payment_method` permission must be included.
*/
permissions?: Array<FinancialConnections.Permission>;
/**
* Data features requested to be retrieved upon account creation.
*/
prefetch: Array<FinancialConnections.Prefetch> | null;
}
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
namespace FinancialConnections {
interface Filters {
/**
* The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
*/
account_subcategories?: Array<Filters.AccountSubcategory>;
}
type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
type Prefetch = 'balances' | 'ownership' | 'transactions';
namespace Filters {
type AccountSubcategory = 'checking' | 'savings';
}
}
}
}
}
namespace PendingInvoiceItemInterval {
type Interval = 'day' | 'month' | 'week' | 'year';
}
namespace TrialSettings {
interface EndBehavior {
/**
* Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
*/
missing_payment_method: EndBehavior.MissingPaymentMethod;
}
namespace EndBehavior {
type MissingPaymentMethod = 'cancel' | 'create_invoice' | 'pause';
}
}
}
export interface SubscriptionCreateParams {
/**
* A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
*/
add_invoice_items?: Array<SubscriptionCreateParams.AddInvoiceItem>;
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
*/
application_fee_percent?: Emptyable<number>;
/**
* Automatic tax settings for this subscription.
*/
automatic_tax?: SubscriptionCreateParams.AutomaticTax;
/**
* A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
*/
backdate_start_date?: number;
/**
* A future timestamp in UTC format to anchor the subscription's [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
*/
billing_cycle_anchor?: number;
/**
* Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurrence of the day_of_month at the hour, minute, and second UTC.
*/
billing_cycle_anchor_config?: SubscriptionCreateParams.BillingCycleAnchorConfig;
/**
* Controls how prorations and invoices for subscriptions are calculated and orchestrated.
*/
billing_mode?: SubscriptionCreateParams.BillingMode;
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Emptyable<SubscriptionCreateParams.BillingThresholds>;
/**
* A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
*/
cancel_at?: number | SubscriptionCreateParams.CancelAt;
/**
* Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
*/
cancel_at_period_end?: boolean;
/**
* Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
*/
collection_method?: SubscriptionCreateParams.CollectionMethod;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
currency?: string;
/**
* The identifier of the customer to subscribe.
*/
customer?: string;
/**
* The identifier of the account representing the customer to subscribe.
*/
customer_account?: string;
/**
* Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
*/
days_until_due?: number;
/**
* ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
*/
default_payment_method?: string;
/**
* ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source).
*/
default_source?: string;
/**
* The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
*/
default_tax_rates?: Emptyable<Array<string>>;
/**
* The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
*/
description?: string;
/**
* The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
*/
discounts?: Emptyable<Array<SubscriptionCreateParams.Discount>>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* All invoices will be billed using the specified settings.
*/
invoice_settings?: SubscriptionCreateParams.InvoiceSettings;
/**
* A list of up to 20 subscription items, each with an attached price.
*/
items?: Array<SubscriptionCreateParams.Item>;
/**
* Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Emptyable<MetadataParam>;
/**
* Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
*/
off_session?: boolean;
/**
* The account on behalf of which to charge, for each of the subscription's invoices.
*/
on_behalf_of?: Emptyable<string>;
/**
* Only applies to subscriptions with `collection_method=charge_automatically`.
*
* Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
*
* Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription's invoice, such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.
*
* Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/upgrades#2019-03-14) to learn more.
*
* `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.
*
* Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.
*/
payment_behavior?: SubscriptionCreateParams.PaymentBehavior;
/**
* Payment settings to pass to invoices created by the subscription.
*/
payment_settings?: SubscriptionCreateParams.PaymentSettings;
/**
* Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api/invoices/create) for the given subscription at the specified interval.
*/
pending_invoice_item_interval?: Emptyable<SubscriptionCreateParams.PendingInvoiceItemInterval>;
/**
* Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
*/
proration_behavior?: SubscriptionCreateParams.ProrationBehavior;
/**
* If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
*/
transfer_data?: SubscriptionCreateParams.TransferData;
/**
* Unix timestamp representing the end of the trial period the customer will get