--- title: "List all promotion codes" method: GET path: "/v1/promotion_codes" --- # List all promotion codes `GET /v1/promotion_codes` Returns a list of your promotion codes. ## Query parameters - `active` boolean - `code` string - `coupon` string - `created` union - object - `gt` integer - `gte` integer - `lt` integer - `lte` integer - integer - `customer` string - `customer_account` string - `ending_before` string - `expand` string[] - `limit` integer - `starting_after` string ## Response `200` Successful response. - object - `data` PromotionCode[], required - `active` boolean, required — Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. - `code` string, required — The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-). - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `customer` union — The customer who can use this promotion code. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - `address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `balance` integer — The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance). - `business_name` string — The customer's business name. - `cash_balance` CashBalance — A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. - `available` object, nullable — A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `customer` string, required — The ID of the customer whose cash balance this object represents. - `customer_account` string, nullable — The ID of an Account representing a customer whose cash balance this object represents. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'cash_balance', required — String representing the object's type. Objects of the same type share the same value. - `settings` CustomerBalanceCustomerBalanceSettings, required - `reconciliation_mode` 'automatic' | 'manual', required — The configuration for how funds that land in the customer cash balance are reconciled. - `using_merchant_default` boolean, required — A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. - `customer_account` string, nullable — The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter. - `default_source` union — ID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - `account` union — The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`. - … - `account_holder_name` string, nullable — The name of the person or business that owns the bank account. - `account_holder_type` string, nullable — The type of entity that holds the account. This can be either `individual` or `company`. - `account_type` string, nullable — The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. - `available_payout_methods` string[], nullable — A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. - `bank_name` string, nullable — Name of the bank associated with the routing number (e.g., `WELLS FARGO`). - `country` string, required — Two-letter ISO code representing the country the bank account is located in. - `currency` string, currency, required — Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. - `customer` union — The ID of the customer that the bank account is associated with. - … - `default_for_currency` boolean, nullable — Whether this bank account is the default external account for its currency. - `fingerprint` string, nullable — Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. - `future_requirements` ExternalAccountRequirements - … - `id` string, required — Unique identifier for the object. - `last4` string, required — The last four digits of the bank account number. - `metadata` object, nullable — 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. - `object` 'bank_account', required — String representing the object's type. Objects of the same type share the same value. - `requirements` ExternalAccountRequirements - … - `routing_number` string, nullable — The routing transit number for the bank account. - `status` string, required — For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, `tokenized_account_number_deactivated` or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If the status is `tokenized_account_number_deactivated`, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated. For external accounts, possible values are `new`, `errored`, `verification_failed`, and `tokenized_account_number_deactivated`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - `account` union - … - `address_city` string, nullable — City/District/Suburb/Town/Village. - `address_country` string, nullable — Billing address country, if provided when creating card. - `address_line1` string, nullable — Address line 1 (Street address/PO Box/Company name). - `address_line1_check` string, nullable — If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. - `address_line2` string, nullable — Address line 2 (Apartment/Suite/Unit/Building). - `address_state` string, nullable — State/County/Province/Region. - `address_zip` string, nullable — ZIP or postal code. - `address_zip_check` string, nullable — If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. - `allow_redisplay` 'always' | 'limited' | 'unspecified', nullable — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `available_payout_methods` string[], nullable — A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. - `brand` string, required — Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. - `country` string, nullable — Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. - `currency` string, currency, nullable — Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`. - `customer` union — The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. - … - `cvc_check` string, nullable — If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). - `default_for_currency` boolean, nullable — Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. - `dynamic_last4` string, nullable — (For tokenized numbers only.) The last four digits of the device account number. - `exp_month` integer, required — Two-digit number representing the card's expiration month. - `exp_year` integer, required — Four-digit number representing the card's expiration year. - `fingerprint` string, nullable — Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* - `funding` string, required — Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. - `id` string, required — Unique identifier for the object. - `last4` string, required — The last four digits of the card. - `metadata` object, nullable — 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. - `name` string, nullable — Cardholder name. - `networks` TokenCardNetworks - … - `object` 'card', required — String representing the object's type. Objects of the same type share the same value. - `regulated_status` 'regulated' | 'unregulated', nullable — Status of a card based on the card issuer. - `status` string, nullable — For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated. - `tokenization_method` string, nullable — If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - `ach_credit_transfer` SourceTypeAchCreditTransfer - … - `ach_debit` SourceTypeAchDebit - … - `acss_debit` SourceTypeAcssDebit - … - `alipay` SourceTypeAlipay - … - `allow_redisplay` 'always' | 'limited' | 'unspecified', nullable — This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. - `amount` integer, nullable — A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. - `au_becs_debit` SourceTypeAuBecsDebit - … - `bancontact` SourceTypeBancontact - … - `card` SourceTypeCard - … - `card_present` SourceTypeCardPresent - … - `client_secret` string, required — The client secret of the source. Used for client-side retrieval using a publishable key. - `code_verification` SourceCodeVerificationFlow - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. - `customer` string — The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. - `eps` SourceTypeEps - … - `flow` string, required — The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. - `giropay` SourceTypeGiropay - … - `id` string, required — Unique identifier for the object. - `ideal` SourceTypeIdeal - … - `klarna` SourceTypeKlarna - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object, nullable — 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. - `multibanco` SourceTypeMultibanco - … - `object` 'source', required — String representing the object's type. Objects of the same type share the same value. - `owner` SourceOwner - … - `p24` SourceTypeP24 - … - `receiver` SourceReceiverFlow - … - `redirect` SourceRedirectFlow - … - `sepa_debit` SourceTypeSepaDebit - … - `sofort` SourceTypeSofort - … - `source_order` SourceOrder - … - `statement_descriptor` string, nullable — Extra information about a source. This will appear on your customer's statement every time you charge the source. - `status` string, required — The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. - `three_d_secure` SourceTypeThreeDSecure - … - `type` 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'alipay' | 'au_becs_debit' | 'bancontact' | 'card' | 'card_present' | 'eps' | 'giropay' | 'ideal' | 'klarna' | 'multibanco' | 'p24' | 'sepa_debit' | 'sofort' | 'three_d_secure' | 'wechat', required — The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used. - `usage` string, nullable — Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. - `wechat` SourceTypeWechat - … - `delinquent` boolean, nullable — Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `discount` Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - string - Customer — recursive - DeletedCustomer - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `end` integer, nullable — If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. - `id` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - string - PromotionCode — recursive - `source` DiscountSource, required - `coupon` union — The coupon that was redeemed to create this discount. - … - `type` 'coupon', required — The source type of the discount. - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - `email` string, nullable — The customer's email address. - `id` string, required — Unique identifier for the object. - `individual_name` string — The customer's individual name. - `invoice_credit_balance` object — The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. - `invoice_prefix` string, nullable — The prefix for the customer used to generate unique invoice numbers. - `invoice_settings` InvoiceSettingCustomerSetting - `custom_fields` InvoiceSettingCustomField[], nullable — Default custom fields to be displayed on invoices for this customer. - `name` string, required — The name of the custom field. - `value` string, required — The value of the custom field. - `default_payment_method` union — ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. - string - PaymentMethod — PaymentMethod objects represent your customer's payment instruments. You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). - … - `footer` string, nullable — Default footer to be displayed on invoices for this customer. - `rendering_options` InvoiceSettingCustomerRenderingOptions - `amount_tax_display` string, nullable — How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. - `template` string, nullable — ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object — 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. - `name` string, nullable — The customer's full name or business name. - `next_invoice_sequence` integer — The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The customer's phone number. - `preferred_locales` string[], nullable — The customer's preferred locales (languages), ordered by preference. - `shipping` Shipping - `address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. - `sources` object — The customer's payment sources, if any. - `data` union[], required — Details about each object. - union - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `subscriptions` object — The customer's current subscriptions, if any. - `data` Subscription[], required — Details about each object. - `application` union — ID of the Connect Application that created the subscription. - … - `application_fee_percent` number, nullable — 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. - `automatic_tax` SubscriptionAutomaticTax, required - … - `billing_cycle_anchor` integer, required — 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_config` SubscriptionsResourceBillingCycleAnchorConfig - … - `billing_mode` SubscriptionsResourceBillingMode, required — The billing mode of the subscription. - … - `billing_schedules` SubscriptionsResourceBillingSchedules[], required — Billing schedules for this subscription. - … - `billing_thresholds` SubscriptionBillingThresholds - … - `cancel_at` integer, nullable — A date in the future at which the subscription will automatically get canceled - `cancel_at_period_end` boolean, required — Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. - `canceled_at` integer, nullable — 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. - `cancellation_details` CancellationDetails - … - `collection_method` 'charge_automatically' | 'send_invoice', required — 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`. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, required — 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). - `customer` union, required — ID of the customer who owns the subscription. - … - `customer_account` string, nullable — ID of the account representing the customer who owns the subscription. - `days_until_due` integer, nullable — 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`. - `default_payment_method` union — 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_source` union — 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_tax_rates` TaxRate[], nullable — 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. - … - `description` string, nullable — 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. - `discounts` union[], required — The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. - … - `ended_at` integer, nullable — If the subscription has ended, the date the subscription ended. - `id` string, required — Unique identifier for the object. - `invoice_settings` SubscriptionsResourceSubscriptionInvoiceSettings, required - … - `items` object, required — List of subscription items, each with an attached price. - … - `latest_invoice` union — The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated). - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `managed_payments` SmorResourceManagedPayments - … - `metadata` object, required — 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. - `next_pending_invoice_item_invoice` integer, nullable — Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. - `object` 'subscription', required — String representing the object's type. Objects of the same type share the same value. - `on_behalf_of` union — 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. - … - `pause_collection` SubscriptionsResourcePauseCollection — The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription should be paused. - … - `payment_settings` SubscriptionsResourcePaymentSettings - … - `pending_invoice_item_interval` SubscriptionPendingInvoiceItemInterval - … - `pending_setup_intent` union — 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_update` SubscriptionsResourcePendingUpdate — Pending Updates store the changes pending from a previous update that will be applied to the Subscription upon successful payment. - … - `presentment_details` SubscriptionsResourceSubscriptionPresentmentDetails - … - `schedule` union — The schedule attached to the subscription - … - `start_date` integer, required — Date when the subscription was first created. The date might differ from the `created` date due to backdating. - `status` 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'paused' | 'trialing' | 'unpaid', required — 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. - `test_clock` union — ID of the test clock this subscription belongs to. - … - `transfer_data` SubscriptionTransferData - … - `trial_end` integer, nullable — If the subscription has a trial, the end of that trial. - `trial_settings` SubscriptionsResourceTrialSettingsTrialSettings — Configures how this subscription behaves during the trial period. - … - `trial_start` integer, nullable — If the subscription has a trial, the beginning of that trial. - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `tax` CustomerTax - `automatic_tax` 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location', required — Surfaces if automatic tax computation is possible given the current customer location information. - `ip_address` string, nullable — A recent IP address of the customer used for tax reporting and tax location inference. - `location` CustomerTaxLocation - `country` string, required — The identified tax country of the customer. - `source` 'billing_address' | 'ip_address' | 'payment_method' | 'shipping_destination', required — The data source used to infer the customer's location. - `state` string, nullable — The identified tax state, county, province, or region of the customer. - `provider` 'anrok' | 'avalara' | 'sphere' | 'stripe', required — The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps). - `tax_exempt` 'exempt' | 'none' | 'reverse', nullable — Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**. - `tax_ids` object — The customer's tax IDs. - `data` TaxId[], required — Details about each object. - `country` string, nullable — Two-letter ISO code representing the country of the tax ID. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `customer` union — ID of the customer. - … - `customer_account` string, nullable — ID of the Account representing the customer. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'tax_id', required — String representing the object's type. Objects of the same type share the same value. - `owner` TaxIDsOwner - … - `type` 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'eu_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'ic_nif' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'unknown' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin', required — Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `fo_vat`, `gb_vat`, `ge_vat`, `gi_tin`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `ic_nif`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `it_cf`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `py_ruc`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` - `value` string, required — Value of the tax ID. - `verification` TaxIdVerification - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `test_clock` union — ID of the test clock that this customer belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `deletes_after` integer, required — Time at which this clock is scheduled to auto delete. - `frozen_time` integer, required — Time at which all objects belonging to this clock are frozen. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `name` string, nullable — The custom name supplied at creation. - `object` 'test_helpers.test_clock', required — String representing the object's type. Objects of the same type share the same value. - `status` 'advancing' | 'internal_failure' | 'ready', required — The status of the Test Clock. - `status_details` BillingClocksResourceStatusDetailsStatusDetails, required - … - DeletedCustomer - `deleted` true, required — Always true for a deleted object - `id` string, required — Unique identifier for the object. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `customer_account` string, nullable — The account representing the customer who can use this promotion code. - `expires_at` integer, nullable — Date at which the promotion code can no longer be redeemed. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `max_redemptions` integer, nullable — Maximum number of times this promotion code can be redeemed. - `metadata` object, nullable — 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. - `object` 'promotion_code', required — String representing the object's type. Objects of the same type share the same value. - `promotion` PromotionCodesResourcePromotion, required - `coupon` union — If promotion `type` is `coupon`, the coupon for this promotion. - string - Coupon — A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices), [checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more. Coupons do not work with conventional one-off [charges](/api/charges/create) or [payment intents](https://docs.stripe.com/api/payment_intents). - `amount_off` integer, nullable — Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. - `applies_to` CouponAppliesTo - `products` string[], required — A list of product IDs this coupon applies to - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, currency, nullable — If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. - `currency_options` object — Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). - `duration` 'forever' | 'once' | 'repeating', required — One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount. - `duration_in_months` integer, nullable — If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. - `id` string, required — Unique identifier for the object. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `max_redemptions` integer, nullable — Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. - `metadata` object, nullable — 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. - `name` string, nullable — Name of the coupon displayed to customers on for instance invoices or receipts. - `object` 'coupon', required — String representing the object's type. Objects of the same type share the same value. - `percent_off` number, nullable — Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. - `redeem_by` integer, nullable — Date after which the coupon can no longer be redeemed. - `times_redeemed` integer, required — Number of times this coupon has been applied to a customer. - `valid` boolean, required — Taking account of the above properties, whether this coupon can still be applied to a customer. - `type` 'coupon', required — The type of promotion. - `restrictions` PromotionCodesResourceRestrictions, required - `currency_options` object — Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). - `first_time_transaction` boolean, required — A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices - `minimum_amount` integer, nullable — Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). - `minimum_amount_currency` string, nullable — Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount - `times_redeemed` integer, required — Number of times this promotion code has been used. - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. ## Other responses - `default` — Error response. --- [API](https://skmtc.net/stripe/apis/spec3.md) · [All operations](https://skmtc.net/stripe/apis/spec3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/spec3/revisions/3653ad45bbec/schema)