The Customer object 

Attributes

• idstring

  Unique identifier for the object.

• addressnullable object

  The customer’s address.

  Hide child attributes

  • address.citynullable string

    City, district, suburb, town, or village.

  • address.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • address.line1nullable string

    Address line 1, such as the street, PO Box, or company name.

  • address.line2nullable string

    Address line 2, such as the apartment, suite, unit, or building.

  • address.postal_codenullable string

    ZIP or postal code.

  • address.statenullable string

    State, county, province, or region.

• descriptionnullable string

  An arbitrary string attached to the object. Often useful for displaying to users.

• emailnullable string

  The customer’s email address.

• metadataobject

  Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• namenullable string

  The customer’s full name or business name.

• phonenullable string

  The customer’s phone number.

• shippingnullable object

  Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

  Hide child attributes

  • shipping.addressobject

    Customer shipping address.

    Hide child attributes

    • shipping.address.citynullable string

      City, district, suburb, town, or village.

    • shipping.address.countrynullable string

      Two-letter country code (ISO 3166-1 alpha-2).

    • shipping.address.line1nullable string

      Address line 1, such as the street, PO Box, or company name.

    • shipping.address.line2nullable string

      Address line 2, such as the apartment, suite, unit, or building.

    • shipping.address.postal_codenullable string

      ZIP or postal code.

    • shipping.address.statenullable string

      State, county, province, or region.

  • shipping.namestring

    Customer name.

  • shipping.phonenullable string

    Customer phone (including extension).

• taxobjectExpandable

  Tax details for the customer.

  Hide child attributes

  • tax.automatic_taxenum

    Surfaces if automatic tax computation is possible given the current customer location information.

    Possible enum values

    failed There was an error determining the customer’s location. This is usually caused by a temporary issue. Retrieve the customer to try again.

    not_collecting The customer is located in a country or state where you’re not registered to collect tax. Also returned when automatic tax calculation is not supported in the customer’s location.

    supported The customer is located in a country or state where you’re collecting tax.

    unrecognized_location The customer’s location couldn’t be determined. Make sure the provided address information is valid and supported in the customer’s country.

  • tax.ip_addressnullable string

    A recent IP address of the customer used for tax reporting and tax location inference.

  • tax.locationnullable object

    The identified tax location of the customer.

    Hide child attributes

    • tax.location.countrystring

      The identified tax country of the customer.

    • tax.location.sourceenum

      The data source used to infer the customer’s location.

    • tax.location.statenullable string

      The identified tax state, county, province, or region of the customer.

  • tax.providerenum

    The tax calculation provider used for location resolution. Defaults to stripe when not using a third-party provider.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• balanceinteger

  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.

• business_namenullable string

  The customer’s business name.

• cash_balancenullable objectExpandable

  The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is “cash_balance”. The settings[reconciliation_mode] field describes if these funds apply to these payment intents manually or automatically.

  Hide child attributes

  • cash_balance.objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • cash_balance.availablenullable object

    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.

  • cash_balance.customerstring

    The ID of the customer whose cash balance this object represents.

  • cash_balance.livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • cash_balance.settingsobject

    A hash of settings for this cash balance.

    Hide child attributes

    • cash_balance.settings.reconciliation_modeenum

      The configuration for how funds that land in the customer cash balance are reconciled.

      Possible enum values

      automatic

      manual

    • cash_balance.settings.using_merchant_defaultboolean

      A flag to indicate if reconciliation mode returned is the user’s default or is specific to this customer cash balance

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• currencynullable string

  Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

• default_sourcenullable stringExpandable

  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 field instead.

• delinquentnullable boolean

  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, 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.

• discountnullable object

  Describes the current discount active on the customer, if there is one.

  Hide child attributes

  • discount.idstring

    The ID of the discount object. Discounts cannot be fetched by ID. Use expand[]=discounts in API calls to expand discount IDs in an array.

  • discount.objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • discount.checkout_sessionnullable string

    The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

  • discount.customernullable stringExpandable

    The ID of the customer associated with this discount.

  • discount.endnullable timestamp

    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.

  • discount.invoicenullable string

    The invoice that the discount’s coupon was applied to, if it was applied directly to a particular invoice.

  • discount.invoice_itemnullable string

    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.

  • discount.promotion_codenullable stringExpandable

    The promotion code applied to create this discount.

  • discount.sourceobject

    The source of the discount.

    Hide child attributes

    • discount.source.couponnullable stringExpandable

      The coupon that was redeemed to create this discount.

    • discount.source.typeenum

      The source type of the discount.

      Possible enum values

      coupon Coupon source type

  • discount.starttimestamp

    Date that the coupon was applied.

  • discount.subscriptionnullable string

    The subscription that this coupon is applied to, if it is applied to a particular subscription.

  • discount.subscription_itemnullable string

    The subscription item that this coupon is applied to, if it is applied to a particular subscription item.

• individual_namenullable string

  The customer’s individual name.

• invoice_credit_balanceobjectExpandable

  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_prefixnullable string

  The prefix for the customer used to generate unique invoice numbers.

• invoice_settingsobject

  The customer’s default invoice settings.

  Hide child attributes

  • invoice_settings.custom_fieldsnullable array of objects

    Default custom fields to be displayed on invoices for this customer.

    Hide child attributes

    • invoice_settings.custom_fields.namestring

      The name of the custom field.

    • invoice_settings.custom_fields.valuestring

      The value of the custom field.

  • invoice_settings.default_payment_methodnullable stringExpandable

    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.

  • invoice_settings.footernullable string

    Default footer to be displayed on invoices for this customer.

  • invoice_settings.rendering_optionsnullable object

    Default options for invoice PDF rendering for this customer.

    Hide child attributes

    • invoice_settings.rendering_options.amount_tax_displaynullable string

      How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.

    • invoice_settings.rendering_options.templatenullable string

      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.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• next_invoice_sequencenullable 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.

• preferred_localesnullable array of strings

  The customer’s preferred locales (languages), ordered by preference.

• sourcesnullable objectExpandable

  The customer’s payment sources, if any.

  Hide child attributes

  • sources.objectstring

    String representing the object’s type. Objects of the same type share the same value. Always has the value list.

  • sources.dataarray of objects

    Details about each object.

    Hide child attributes

    • sources.data.idstring

      Unique identifier for the object.

    • sources.data.objectstring

      String representing the object’s type. Objects of the same type share the same value.

    • sources.data.accountnullable stringExpandableAvailable conditionally

      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 where controller.is_controller is true.

    • sources.data.account_holder_namenullable string

      The name of the person or business that owns the bank account.

    • sources.data.account_holder_typenullable string

      The type of entity that holds the account. This can be either individual or company.

    • sources.data.account_typenullable string

      The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.

    • sources.data.available_payout_methodsnullable array of enums

      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.

      Possible enum values

      instant

      standard

    • sources.data.bank_namenullable string

      Name of the bank associated with the routing number (e.g., WELLS FARGO).

    • sources.data.countrystring

      Two-letter ISO code representing the country the bank account is located in.

    • sources.data.currencyenum

      Three-letter ISO code for the currency paid out to the bank account.

    • sources.data.customernullable stringExpandable

      The ID of the customer that the bank account is associated with.

    • sources.data.fingerprintnullable string

      Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

    • sources.data.last4string

      The last four digits of the bank account number.

    • sources.data.metadatanullable object

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • sources.data.routing_numbernullable string

      The routing transit number for the bank account.

    • sources.data.statusstring

      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 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, 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.

  • sources.has_moreboolean

    True if this list has another page of items after this one that can be fetched.

  • sources.urlstring

    The URL where this list can be accessed.

• subscriptionsnullable objectExpandable

  The customer’s current subscriptions, if any.

  Hide child attributes

  • subscriptions.objectstring

    String representing the object’s type. Objects of the same type share the same value. Always has the value list.

  • subscriptions.dataarray of objects

    Details about each object.

    Hide child attributes

    • subscriptions.data.idstring

      Unique identifier for the object.

    • subscriptions.data.objectstring

      String representing the object’s type. Objects of the same type share the same value.

    • subscriptions.data.applicationnullable stringExpandableConnect only

      ID of the Connect Application that created the subscription.

    • subscriptions.data.application_fee_percentnullable floatConnect only

      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.

    • subscriptions.data.automatic_taxobject

      Automatic tax settings for this subscription.

      Hide child attributes

      • subscriptions.data.automatic_tax.disabled_reasonnullable enum

        If Stripe disabled automatic tax, this enum describes why.

        Possible enum values

        requires_location_inputs Stripe’s systems automatically turned off Tax for this subscription when finalizing one of its invoices with a missing or incomplete location for your customer.

      • subscriptions.data.automatic_tax.enabledboolean

        Whether Stripe automatically computes tax on this subscription.

      • subscriptions.data.automatic_tax.liabilitynullable objectConnect only

        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.

        Hide child attributes

        • subscriptions.data.automatic_tax.liability.accountnullable stringExpandable

          The connected account being referenced when type is account.

        • subscriptions.data.automatic_tax.liability.typeenum

          Type of the account referenced.

          Possible enum values

          account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

          self Indicates that the account being referenced is the account making the API request.

    • subscriptions.data.billing_cycle_anchortimestamp

      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. The timestamp is in UTC format.

    • subscriptions.data.billing_cycle_anchor_confignullable object

      The fixed values used to calculate the billing_cycle_anchor.

      Hide child attributes

      • subscriptions.data.billing_cycle_anchor_config.day_of_monthinteger

        The day of the month of the billing_cycle_anchor.

      • subscriptions.data.billing_cycle_anchor_config.hournullable integer

        The hour of the day of the billing_cycle_anchor.

      • subscriptions.data.billing_cycle_anchor_config.minutenullable integer

        The minute of the hour of the billing_cycle_anchor.

      • subscriptions.data.billing_cycle_anchor_config.monthnullable integer

        The month to start full cycle billing periods.

      • subscriptions.data.billing_cycle_anchor_config.secondnullable integer

        The second of the minute of the billing_cycle_anchor.

    • subscriptions.data.billing_modeobject

      Controls how prorations and invoices for subscriptions are calculated and orchestrated.

      Hide child attributes

      • subscriptions.data.billing_mode.flexiblenullable object

        Configure behavior for flexible billing mode

        Hide child attributes

        • subscriptions.data.billing_mode.flexible.proration_discountsenum

          Controls how invoices and invoice items display proration amounts and discount amounts.

          Possible enum values

          included Amounts are net of discounts, and discount amounts are zero.

          itemized Amounts are gross of discounts, and discount amounts are accurate.

      • subscriptions.data.billing_mode.typeenum

        Controls how prorations and invoices for subscriptions are calculated and orchestrated.

        Possible enum values

        classic Calculations for subscriptions and invoices are based on legacy defaults.

        flexible Supports more flexible calculation and orchestration options for subscriptions and invoices.

      • subscriptions.data.billing_mode.updated_atnullable timestamp

        Details on when the current billing_mode was adopted.

    • subscriptions.data.billing_thresholdsnullable object

      Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period

      Hide child attributes

      • subscriptions.data.billing_thresholds.amount_gtenullable integer

        Monetary threshold that triggers the subscription to create an invoice

      • subscriptions.data.billing_thresholds.reset_billing_cycle_anchornullable boolean

        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.

    • subscriptions.data.cancel_atnullable timestamp

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

    • subscriptions.data.cancel_at_period_endboolean

      Whether this subscription will (if status=active) or did (if status=canceled) cancel at the end of the current billing period.

    • subscriptions.data.canceled_atnullable timestamp

      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.

    • subscriptions.data.cancellation_detailsnullable object

      Details about why this subscription was cancelled

      Hide child attributes

      • subscriptions.data.cancellation_details.commentnullable string

        Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.

      • subscriptions.data.cancellation_details.feedbacknullable enum

        The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.

        Possible enum values

        customer_service Customer service was less than expected

        low_quality Quality was less than expected

        missing_features Some features are missing

        other Other reason

        switched_service I’m switching to a different service

        too_complex Ease of use was less than expected

        too_expensive It’s too expensive

        unused I don’t use the service enough

      • subscriptions.data.cancellation_details.reasonnullable enum

        Why this subscription was canceled.

        Possible enum values

        cancellation_requested

        payment_disputed

        payment_failed

    • subscriptions.data.collection_methodenum

      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.

      Possible enum values

      charge_automatically

      send_invoice

    • subscriptions.data.createdtimestamp

      Time at which the object was created. Measured in seconds since the Unix epoch.

    • subscriptions.data.currencyenum

      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • subscriptions.data.customerstringExpandable

      ID of the customer who owns the subscription.

    • subscriptions.data.days_until_duenullable integer

      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.

    • subscriptions.data.default_payment_methodnullable stringExpandable

      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 or default_source.

    • subscriptions.data.default_sourcenullable stringExpandable

      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 or default_source.

    • subscriptions.data.default_tax_ratesnullable array of objects

      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.

      Hide child attributes

      • subscriptions.data.default_tax_rates.idstring

        Unique identifier for the object.

      • subscriptions.data.default_tax_rates.objectstring

        String representing the object’s type. Objects of the same type share the same value.

      • subscriptions.data.default_tax_rates.activeboolean

        Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

      • subscriptions.data.default_tax_rates.countrynullable string

        Two-letter country code (ISO 3166-1 alpha-2).

      • subscriptions.data.default_tax_rates.createdtimestamp

        Time at which the object was created. Measured in seconds since the Unix epoch.

      • subscriptions.data.default_tax_rates.descriptionnullable string

        An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

      • subscriptions.data.default_tax_rates.display_namestring

        The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

      • subscriptions.data.default_tax_rates.effective_percentagenullable float

        Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

      • subscriptions.data.default_tax_rates.flat_amountnullable object

        The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

        Hide child attributes

        • subscriptions.data.default_tax_rates.flat_amount.amountinteger

          Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

        • subscriptions.data.default_tax_rates.flat_amount.currencystring

          Three-letter ISO currency code, in lowercase.

      • subscriptions.data.default_tax_rates.inclusiveboolean

        This specifies if the tax rate is inclusive or exclusive.

      • subscriptions.data.default_tax_rates.jurisdictionnullable string

        The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

      • subscriptions.data.default_tax_rates.jurisdiction_levelnullable enum

        The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

        Possible enum values

        city

        country

        county

        district

        multiple

        state

      • subscriptions.data.default_tax_rates.livemodeboolean

        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • subscriptions.data.default_tax_rates.metadatanullable object

        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

      • subscriptions.data.default_tax_rates.percentagefloat

        Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

      • subscriptions.data.default_tax_rates.rate_typenullable enum

        Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.

        Possible enum values

        flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

        percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

      • subscriptions.data.default_tax_rates.statenullable string

        ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

      • subscriptions.data.default_tax_rates.tax_typenullable enum

        The high-level tax type, such as vat or sales_tax.

        Possible enum values

        amusement_tax Amusement Tax

        communications_tax Communications Tax

        gst Goods and Services Tax

        hst Harmonized Sales Tax

        igst Integrated Goods and Services Tax

        jct Japanese Consumption Tax

        lease_tax Chicago Lease Tax

        pst Provincial Sales Tax

        qst Quebec Sales Tax

        retail_delivery_fee Retail Delivery Fee

        Show 4 more

    • subscriptions.data.descriptionnullable 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.

    • subscriptions.data.discountsarray of stringsExpandable

      The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.

    • subscriptions.data.ended_atnullable timestamp

      If the subscription has ended, the date the subscription ended.

    • subscriptions.data.invoice_settingsobject

      All invoices will be billed using the specified settings.

      Hide child attributes

      • subscriptions.data.invoice_settings.account_tax_idsnullable array of stringsExpandable

        The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.

      • subscriptions.data.invoice_settings.issuerobjectConnect only

        The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

        Hide child attributes

        • subscriptions.data.invoice_settings.issuer.accountnullable stringExpandable

          The connected account being referenced when type is account.

        • subscriptions.data.invoice_settings.issuer.typeenum

          Type of the account referenced.

          Possible enum values

          account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

          self Indicates that the account being referenced is the account making the API request.

    • subscriptions.data.itemsobject

      List of subscription items, each with an attached price.

      Hide child attributes

      • subscriptions.data.items.objectstring

        String representing the object’s type. Objects of the same type share the same value. Always has the value list.

      • subscriptions.data.items.dataarray of objects

        Details about each object.

        Hide child attributes

        • subscriptions.data.items.data.idstring

          Unique identifier for the object.

        • subscriptions.data.items.data.objectstring

          String representing the object’s type. Objects of the same type share the same value.

        • subscriptions.data.items.data.billing_thresholdsnullable object

          Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period

          Hide child attributes

          • subscriptions.data.items.data.billing_thresholds.usage_gtenullable integer

            Usage threshold that triggers the subscription to create an invoice

        • subscriptions.data.items.data.createdinteger

          Time at which the object was created. Measured in seconds since the Unix epoch.

        • subscriptions.data.items.data.current_period_endtimestamp

          The end time of this subscription item’s current billing period.

        • subscriptions.data.items.data.current_period_starttimestamp

          The start time of this subscription item’s current billing period.

        • subscriptions.data.items.data.discountsarray of stringsExpandable

          The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.

        • subscriptions.data.items.data.metadataobject

          Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

        • subscriptions.data.items.data.priceobject

          The price the customer is subscribed to.

          Hide child attributes

          • subscriptions.data.items.data.price.idstring

            Unique identifier for the object.

          • subscriptions.data.items.data.price.objectstring

            String representing the object’s type. Objects of the same type share the same value.

          • subscriptions.data.items.data.price.activeboolean

            Whether the price can be used for new purchases.

          • subscriptions.data.items.data.price.billing_schemeenum

            Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.

            Possible enum values

            per_unit

            tiered

          • subscriptions.data.items.data.price.createdtimestamp

            Time at which the object was created. Measured in seconds since the Unix epoch.

          • subscriptions.data.items.data.price.currencyenum

            Three-letter ISO currency code, in lowercase. Must be a supported currency.

          • subscriptions.data.items.data.price.currency_optionsnullable objectExpandable

            Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

            Hide child attributes

            • subscriptions.data.items.data.price.currency_options.<currency>.custom_unit_amountnullable object

              When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

              Hide child attributes

              • subscriptions.data.items.data.price.currency_options.<currency>.custom_unit_amount.maximumnullable integer

                The maximum unit amount the customer can specify for this item.

              • subscriptions.data.items.data.price.currency_options.<currency>.custom_unit_amount.minimumnullable integer

                The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

              • subscriptions.data.items.data.price.currency_options.<currency>.custom_unit_amount.presetnullable integer

                The starting unit amount which can be updated by the customer.

            • subscriptions.data.items.data.price.currency_options.<currency>.tax_behaviornullable enum

              Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

              Possible enum values

              exclusive

              inclusive

              unspecified

            • subscriptions.data.items.data.price.currency_options.<currency>.tiersnullable array of objectsExpandable

              Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

              Hide child attributes

              • subscriptions.data.items.data.price.currency_options.<currency>.tiers.flat_amountnullable integer

                Price for the entire tier.

              • subscriptions.data.items.data.price.currency_options.<currency>.tiers.flat_amount_decimalnullable decimal string

                Same as flat_amount, but contains a decimal value with at most 12 decimal places.

              • subscriptions.data.items.data.price.currency_options.<currency>.tiers.unit_amountnullable integer

                Per unit price for units relevant to the tier.

              • subscriptions.data.items.data.price.currency_options.<currency>.tiers.unit_amount_decimalnullable decimal string

                Same as unit_amount, but contains a decimal value with at most 12 decimal places.

              • subscriptions.data.items.data.price.currency_options.<currency>.tiers.up_tonullable integer

                Up to and including to this quantity will be contained in the tier.

            • subscriptions.data.items.data.price.currency_options.<currency>.unit_amountnullable integer

              The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.

            • subscriptions.data.items.data.price.currency_options.<currency>.unit_amount_decimalnullable decimal string

              The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

          • subscriptions.data.items.data.price.custom_unit_amountnullable object

            When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

            Hide child attributes

            • subscriptions.data.items.data.price.custom_unit_amount.maximumnullable integer

              The maximum unit amount the customer can specify for this item.

            • subscriptions.data.items.data.price.custom_unit_amount.minimumnullable integer

              The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

            • subscriptions.data.items.data.price.custom_unit_amount.presetnullable integer

              The starting unit amount which can be updated by the customer.

          • subscriptions.data.items.data.price.livemodeboolean

            Has the value true if the object exists in live mode or the value false if the object exists in test mode.

          • subscriptions.data.items.data.price.lookup_keynullable string

            A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

          • subscriptions.data.items.data.price.metadataobject

            Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

          • subscriptions.data.items.data.price.nicknamenullable string

            A brief description of the price, hidden from customers.

          • subscriptions.data.items.data.price.productstringExpandable

            The ID of the product this price is associated with.

          • subscriptions.data.items.data.price.recurringnullable object

            The recurring components of a price such as interval and usage_type.

            Hide child attributes

            • subscriptions.data.items.data.price.recurring.intervalenum

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

            • subscriptions.data.items.data.price.recurring.interval_countinteger

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

            • subscriptions.data.items.data.price.recurring.meternullable string

              The meter tracking the usage of a metered price

            • subscriptions.data.items.data.price.recurring.usage_typeenum

              Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.

          • subscriptions.data.items.data.price.tax_behaviornullable enum

            Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

            Possible enum values

            exclusive

            inclusive

            unspecified

          • subscriptions.data.items.data.price.tiersnullable array of objectsExpandable

            Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

            Hide child attributes

            • subscriptions.data.items.data.price.tiers.flat_amountnullable integer

              Price for the entire tier.

            • subscriptions.data.items.data.price.tiers.flat_amount_decimalnullable decimal string

              Same as flat_amount, but contains a decimal value with at most 12 decimal places.

            • subscriptions.data.items.data.price.tiers.unit_amountnullable integer

              Per unit price for units relevant to the tier.

            • subscriptions.data.items.data.price.tiers.unit_amount_decimalnullable decimal string

              Same as unit_amount, but contains a decimal value with at most 12 decimal places.

            • subscriptions.data.items.data.price.tiers.up_tonullable integer

              Up to and including to this quantity will be contained in the tier.

          • subscriptions.data.items.data.price.tiers_modenullable enum

            Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.

            Possible enum values

            graduated

            volume

          • subscriptions.data.items.data.price.transform_quantitynullable object

            Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.

            Hide child attributes

            • subscriptions.data.items.data.price.transform_quantity.divide_byinteger

              Divide usage by this number.

            • subscriptions.data.items.data.price.transform_quantity.roundenum

              After division, either round the result up or down.

          • subscriptions.data.items.data.price.typeenum

            One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

            Possible enum values

            one_time

            recurring

          • subscriptions.data.items.data.price.unit_amountnullable integer

            The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.

          • subscriptions.data.items.data.price.unit_amount_decimalnullable decimal string

            The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

        • subscriptions.data.items.data.quantitynullable integer

          The quantity of the plan to which the customer should be subscribed.

        • subscriptions.data.items.data.subscriptionstring

          The subscription this subscription_item belongs to.

        • subscriptions.data.items.data.tax_ratesnullable array of objects

          The tax rates which apply to this subscription_item. When set, the default_tax_rates on the subscription do not apply to this subscription_item.

          Hide child attributes

          • subscriptions.data.items.data.tax_rates.idstring

            Unique identifier for the object.

          • subscriptions.data.items.data.tax_rates.objectstring

            String representing the object’s type. Objects of the same type share the same value.

          • subscriptions.data.items.data.tax_rates.activeboolean

            Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

          • subscriptions.data.items.data.tax_rates.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • subscriptions.data.items.data.tax_rates.createdtimestamp

            Time at which the object was created. Measured in seconds since the Unix epoch.

          • subscriptions.data.items.data.tax_rates.descriptionnullable string

            An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

          • subscriptions.data.items.data.tax_rates.display_namestring

            The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

          • subscriptions.data.items.data.tax_rates.effective_percentagenullable float

            Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

          • subscriptions.data.items.data.tax_rates.flat_amountnullable object

            The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

            Hide child attributes

            • subscriptions.data.items.data.tax_rates.flat_amount.amountinteger

              Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

            • subscriptions.data.items.data.tax_rates.flat_amount.currencystring

              Three-letter ISO currency code, in lowercase.

          • subscriptions.data.items.data.tax_rates.inclusiveboolean

            This specifies if the tax rate is inclusive or exclusive.

          • subscriptions.data.items.data.tax_rates.jurisdictionnullable string

            The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

          • subscriptions.data.items.data.tax_rates.jurisdiction_levelnullable enum

            The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

            Possible enum values

            city

            country

            county

            district

            multiple

            state

          • subscriptions.data.items.data.tax_rates.livemodeboolean

            Has the value true if the object exists in live mode or the value false if the object exists in test mode.

          • subscriptions.data.items.data.tax_rates.metadatanullable object

            Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

          • subscriptions.data.items.data.tax_rates.percentagefloat

            Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

          • subscriptions.data.items.data.tax_rates.rate_typenullable enum

            Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.

            Possible enum values

            flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

            percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

          • subscriptions.data.items.data.tax_rates.statenullable string

            ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

          • subscriptions.data.items.data.tax_rates.tax_typenullable enum

            The high-level tax type, such as vat or sales_tax.

            Possible enum values

            amusement_tax Amusement Tax

            communications_tax Communications Tax

            gst Goods and Services Tax

            hst Harmonized Sales Tax

            igst Integrated Goods and Services Tax

            jct Japanese Consumption Tax

            lease_tax Chicago Lease Tax

            pst Provincial Sales Tax

            qst Quebec Sales Tax

            retail_delivery_fee Retail Delivery Fee

            Show 4 more

      • subscriptions.data.items.has_moreboolean

        True if this list has another page of items after this one that can be fetched.

      • subscriptions.data.items.urlstring

        The URL where this list can be accessed.

    • subscriptions.data.latest_invoicenullable stringExpandable

      The most recent invoice this subscription has generated.

    • subscriptions.data.livemodeboolean

      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • subscriptions.data.metadataobject

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • subscriptions.data.next_pending_invoice_item_invoicenullable timestamp

      Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at pending_invoice_item_interval.

    • subscriptions.data.on_behalf_ofnullable stringExpandableConnect only

      The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.

    • subscriptions.data.pause_collectionnullable object

      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.

      Hide child attributes

      • subscriptions.data.pause_collection.behaviorenum

        The payment collection behavior for this subscription while paused. One of keep_as_draft, mark_uncollectible, or void.

        Possible enum values

        keep_as_draft

        mark_uncollectible

        void

      • subscriptions.data.pause_collection.resumes_atnullable timestamp

        The time after which the subscription will resume collecting payments.

    • subscriptions.data.payment_settingsnullable object

      Payment settings passed on to invoices created by the subscription.

      Hide child attributes

      • subscriptions.data.payment_settings.payment_method_optionsnullable object

        Payment-method-specific configuration to provide to invoices created by the subscription.

        Hide child attributes

        • subscriptions.data.payment_settings.payment_method_options.acss_debitnullable object

          This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.

          Hide child attributes

          • subscriptions.data.payment_settings.payment_method_options.acss_debit.mandate_optionsnullable object

            Additional fields for Mandate creation

            Hide child attributes

            • subscriptions.data.payment_settings.payment_method_options.acss_debit.mandate_options.transaction_typenullable enum

              Transaction type of the mandate.

              Possible enum values

              business Transactions are made for business reasons

              personal Transactions are made for personal reasons

          • subscriptions.data.payment_settings.payment_method_options.acss_debit.verification_methodnullable enum

            Bank account verification method.

            Possible enum values

            automatic Instant verification with fallback to microdeposits.

            instant Instant verification.

            microdeposits Verification using microdeposits.

        • subscriptions.data.payment_settings.payment_method_options.bancontactnullable object

          This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.

          Hide child attributes

          • subscriptions.data.payment_settings.payment_method_options.bancontact.preferred_languageenum

            Preferred language of the Bancontact authorization page that the customer is redirected to.

            Possible enum values

            de German

            en English

            fr French

            nl Dutch

        • subscriptions.data.payment_settings.payment_method_options.cardnullable object

          This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.

          Hide child attributes

          • subscriptions.data.payment_settings.payment_method_options.card.mandate_optionsnullable object

            Configuration options for setting up an eMandate for cards issued in India.

            Hide child attributes

            • subscriptions.data.payment_settings.payment_method_options.card.mandate_options.amountnullable integer

              Amount to be charged for future payments.

            • subscriptions.data.payment_settings.payment_method_options.card.mandate_options.amount_typenullable enum

              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.

              Possible enum values

              fixed If fixed, the amount param refers to the exact amount to be charged in future payments.

              maximum If maximum, the amount charged can be up to the value passed for the amount param.

            • subscriptions.data.payment_settings.payment_method_options.card.mandate_options.descriptionnullable string

              A description of the mandate or subscription that is meant to be displayed to the customer.

          • subscriptions.data.payment_settings.payment_method_options.card.networknullable enum

            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.

            Possible enum values

            amex

            cartes_bancaires

            diners

            discover

            eftpos_au

            girocard

            interac

            jcb

            link

            mastercard

            Show 3 more

          • subscriptions.data.payment_settings.payment_method_options.card.request_three_d_securenullable enumadvanced

            We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.

            Possible enum values

            any Use any to manually request 3DS with a preference for a frictionless flow, increasing the likelihood of the authentication being completed without any additional input from the customer. 3DS will always be attempted if it is supported for the card, but Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

            automatic (Default) Our SCA Engine automatically prompts your customers for authentication based on risk level and other requirements.

            challenge Use challenge to request 3DS with a preference for a challenge flow, where the customer must respond to a prompt for active authentication. Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

        • subscriptions.data.payment_settings.payment_method_options.customer_balancenullable object

          This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.

          Hide child attributes

          • subscriptions.data.payment_settings.payment_method_options.customer_balance.bank_transfernullable object

            Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer.

            Hide child attributes

            • subscriptions.data.payment_settings.payment_method_options.customer_balance.bank_transfer.eu_bank_transfernullable object

              Configuration for eu_bank_transfer funding type.

              Hide child attributes

              • subscriptions.data.payment_settings.payment_method_options.customer_balance.bank_transfer.eu_bank_transfer.countryenum

                The desired country code of the bank account information. Permitted values include: BE, DE, ES, FR, IE, or NL.

                Possible enum values

                BE

                DE

                ES

                FR

                IE

                NL

            • subscriptions.data.payment_settings.payment_method_options.customer_balance.bank_transfer.typenullable enum

              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.

          • subscriptions.data.payment_settings.payment_method_options.customer_balance.funding_typenullable enum

            The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.

            Possible enum values

            bank_transfer

        • subscriptions.data.payment_settings.payment_method_options.konbininullable object

          This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.

        • subscriptions.data.payment_settings.payment_method_options.sepa_debitnullable object

          This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.

        • subscriptions.data.payment_settings.payment_method_options.us_bank_accountnullable object

          This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.

          Hide child attributes

          • subscriptions.data.payment_settings.payment_method_options.us_bank_account.financial_connectionsnullable object

            Additional fields for Financial Connections Session creation

            Hide child attributes

            • subscriptions.data.payment_settings.payment_method_options.us_bank_account.financial_connections.filtersnullable object

              Filter the list of accounts that are allowed to be linked.

              Hide child attributes

              • subscriptions.data.payment_settings.payment_method_options.us_bank_account.financial_connections.filters.account_subcategoriesnullable array of enums

                The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.

                Possible enum values

                checking Bank account subcategory is checking

                savings Bank account subcategory is savings

            • subscriptions.data.payment_settings.payment_method_options.us_bank_account.financial_connections.permissionsnullable array of enums

              The list of permissions to request. The payment_method permission must be included.

              Possible enum values

              balances Allows accessing balance data from the account.

              ownership Allows accessing ownership data from the account.

              payment_method Allows the creation of a payment method from the account.

              transactions Allows accessing transactions data from the account.

            • subscriptions.data.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetchnullable array of enums

              Data features requested to be retrieved upon account creation.

              Possible enum values

              balances Requests to prefetch balance data on accounts collected in this session.

              ownership Requests to prefetch ownership data on accounts collected in this session.

              transactions Requests to prefetch transaction data on accounts collected in this session.

          • subscriptions.data.payment_settings.payment_method_options.us_bank_account.verification_methodnullable enum

            Bank account verification method.

            Possible enum values

            automatic Instant verification with fallback to microdeposits.

            instant Instant verification only.

            microdeposits Verification using microdeposits. Cannot be used with Stripe Checkout, Hosted Invoices, or Payment Element.

      • subscriptions.data.payment_settings.payment_method_typesnullable array of enums

        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.

        Possible enum values

        ach_debit ACH

        acss_debit Canadian pre-authorized debit

        affirm Affirm If set, the Subscription collection_method must be send_invoice.

        amazon_pay Amazon Pay

        au_becs_debit BECS Direct Debit

        bacs_debit Bacs Direct Debit

        bancontact Bancontact If set, the Subscription collection_method must be send_invoice.

        boleto Boleto

        card Card

        cashapp Cash App Pay

        Show 27 more

      • subscriptions.data.payment_settings.save_default_payment_methodnullable enum

        Configure whether Stripe updates subscription.default_payment_method when payment succeeds. Defaults to off.

        Possible enum values

        off Stripe never sets subscription.default_payment_method.

        on_subscription Stripe sets subscription.default_payment_method when a subscription payment succeeds.

    • subscriptions.data.pending_invoice_item_intervalnullable object

      Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.

      Hide child attributes

      • subscriptions.data.pending_invoice_item_interval.intervalenum

        Specifies invoicing frequency. Either day, week, month or year.

        Possible enum values

        day

        month

        week

        year

      • subscriptions.data.pending_invoice_item_interval.interval_countinteger

        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).

    • subscriptions.data.pending_setup_intentnullable stringExpandable

      You can use this SetupIntent 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.

    • subscriptions.data.pending_updatenullable object

      If specified, pending updates that will be applied to the subscription once the latest_invoice has been paid.

      Hide child attributes

      • subscriptions.data.pending_update.billing_cycle_anchornullable timestamp

        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.

      • subscriptions.data.pending_update.expires_attimestamp

        The point after which the changes reflected by this update will be discarded and no longer applied.

      • subscriptions.data.pending_update.subscription_itemsnullable array of objects

        List of subscription items, each with an attached plan, that will be set if the update is applied.

        Hide child attributes

        • subscriptions.data.pending_update.subscription_items.idstring

          Unique identifier for the object.

        • subscriptions.data.pending_update.subscription_items.objectstring

          String representing the object’s type. Objects of the same type share the same value.

        • subscriptions.data.pending_update.subscription_items.billing_thresholdsnullable object

          Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period

          Hide child attributes

          • subscriptions.data.pending_update.subscription_items.billing_thresholds.usage_gtenullable integer

            Usage threshold that triggers the subscription to create an invoice

        • subscriptions.data.pending_update.subscription_items.createdinteger

          Time at which the object was created. Measured in seconds since the Unix epoch.

        • subscriptions.data.pending_update.subscription_items.current_period_endtimestamp

          The end time of this subscription item’s current billing period.

        • subscriptions.data.pending_update.subscription_items.current_period_starttimestamp

          The start time of this subscription item’s current billing period.

        • subscriptions.data.pending_update.subscription_items.discountsarray of stringsExpandable

          The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use expand[]=discounts to expand each discount.

        • subscriptions.data.pending_update.subscription_items.metadataobject

          Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

        • subscriptions.data.pending_update.subscription_items.priceobject

          The price the customer is subscribed to.

          Hide child attributes

          • subscriptions.data.pending_update.subscription_items.price.idstring

            Unique identifier for the object.

          • subscriptions.data.pending_update.subscription_items.price.objectstring

            String representing the object’s type. Objects of the same type share the same value.

          • subscriptions.data.pending_update.subscription_items.price.activeboolean

            Whether the price can be used for new purchases.

          • subscriptions.data.pending_update.subscription_items.price.billing_schemeenum

            Describes how to compute the price per period. Either per_unit or tiered. per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity (for prices with usage_type=licensed), or per unit of total usage (for prices with usage_type=metered). tiered indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.

            Possible enum values

            per_unit

            tiered

          • subscriptions.data.pending_update.subscription_items.price.createdtimestamp

            Time at which the object was created. Measured in seconds since the Unix epoch.

          • subscriptions.data.pending_update.subscription_items.price.currencyenum

            Three-letter ISO currency code, in lowercase. Must be a supported currency.

          • subscriptions.data.pending_update.subscription_items.price.currency_optionsnullable objectExpandable

            Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

            Hide child attributes

            • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.custom_unit_amountnullable object

              When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

              Hide child attributes

              • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.custom_unit_amount.maximumnullable integer

                The maximum unit amount the customer can specify for this item.

              • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.custom_unit_amount.minimumnullable integer

                The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

              • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.custom_unit_amount.presetnullable integer

                The starting unit amount which can be updated by the customer.

            • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.tax_behaviornullable enum

              Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

              Possible enum values

              exclusive

              inclusive

              unspecified

            • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.tiersnullable array of objectsExpandable

              Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

              Hide child attributes

              • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.tiers.flat_amountnullable integer

                Price for the entire tier.

              • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.tiers.flat_amount_decimalnullable decimal string

                Same as flat_amount, but contains a decimal value with at most 12 decimal places.

              • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.tiers.unit_amountnullable integer

                Per unit price for units relevant to the tier.

              • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.tiers.unit_amount_decimalnullable decimal string

                Same as unit_amount, but contains a decimal value with at most 12 decimal places.

              • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.tiers.up_tonullable integer

                Up to and including to this quantity will be contained in the tier.

            • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.unit_amountnullable integer

              The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.

            • subscriptions.data.pending_update.subscription_items.price.currency_options.<currency>.unit_amount_decimalnullable decimal string

              The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

          • subscriptions.data.pending_update.subscription_items.price.custom_unit_amountnullable object

            When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

            Hide child attributes

            • subscriptions.data.pending_update.subscription_items.price.custom_unit_amount.maximumnullable integer

              The maximum unit amount the customer can specify for this item.

            • subscriptions.data.pending_update.subscription_items.price.custom_unit_amount.minimumnullable integer

              The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

            • subscriptions.data.pending_update.subscription_items.price.custom_unit_amount.presetnullable integer

              The starting unit amount which can be updated by the customer.

          • subscriptions.data.pending_update.subscription_items.price.livemodeboolean

            Has the value true if the object exists in live mode or the value false if the object exists in test mode.

          • subscriptions.data.pending_update.subscription_items.price.lookup_keynullable string

            A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

          • subscriptions.data.pending_update.subscription_items.price.metadataobject

            Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

          • subscriptions.data.pending_update.subscription_items.price.nicknamenullable string

            A brief description of the price, hidden from customers.

          • subscriptions.data.pending_update.subscription_items.price.productstringExpandable

            The ID of the product this price is associated with.

          • subscriptions.data.pending_update.subscription_items.price.recurringnullable object

            The recurring components of a price such as interval and usage_type.

            Hide child attributes

            • subscriptions.data.pending_update.subscription_items.price.recurring.intervalenum

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

            • subscriptions.data.pending_update.subscription_items.price.recurring.interval_countinteger

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

            • subscriptions.data.pending_update.subscription_items.price.recurring.meternullable string

              The meter tracking the usage of a metered price

            • subscriptions.data.pending_update.subscription_items.price.recurring.usage_typeenum

              Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.

          • subscriptions.data.pending_update.subscription_items.price.tax_behaviornullable enum

            Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

            Possible enum values

            exclusive

            inclusive

            unspecified

          • subscriptions.data.pending_update.subscription_items.price.tiersnullable array of objectsExpandable

            Each element represents a pricing tier. This parameter requires billing_scheme to be set to tiered. See also the documentation for billing_scheme.

            Hide child attributes

            • subscriptions.data.pending_update.subscription_items.price.tiers.flat_amountnullable integer

              Price for the entire tier.

            • subscriptions.data.pending_update.subscription_items.price.tiers.flat_amount_decimalnullable decimal string

              Same as flat_amount, but contains a decimal value with at most 12 decimal places.

            • subscriptions.data.pending_update.subscription_items.price.tiers.unit_amountnullable integer

              Per unit price for units relevant to the tier.

            • subscriptions.data.pending_update.subscription_items.price.tiers.unit_amount_decimalnullable decimal string

              Same as unit_amount, but contains a decimal value with at most 12 decimal places.

            • subscriptions.data.pending_update.subscription_items.price.tiers.up_tonullable integer

              Up to and including to this quantity will be contained in the tier.

          • subscriptions.data.pending_update.subscription_items.price.tiers_modenullable enum

            Defines if the tiering price should be graduated or volume based. In volume-based tiering, the maximum quantity within a period determines the per unit price. In graduated tiering, pricing can change as the quantity grows.

            Possible enum values

            graduated

            volume

          • subscriptions.data.pending_update.subscription_items.price.transform_quantitynullable object

            Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with tiers.

            Hide child attributes

            • subscriptions.data.pending_update.subscription_items.price.transform_quantity.divide_byinteger

              Divide usage by this number.

            • subscriptions.data.pending_update.subscription_items.price.transform_quantity.roundenum

              After division, either round the result up or down.

          • subscriptions.data.pending_update.subscription_items.price.typeenum

            One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

            Possible enum values

            one_time

            recurring

          • subscriptions.data.pending_update.subscription_items.price.unit_amountnullable integer

            The unit amount in cents to be charged, represented as a whole integer if possible. Only set if billing_scheme=per_unit.

          • subscriptions.data.pending_update.subscription_items.price.unit_amount_decimalnullable decimal string

            The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places. Only set if billing_scheme=per_unit.

        • subscriptions.data.pending_update.subscription_items.quantitynullable integer

          The quantity of the plan to which the customer should be subscribed.

        • subscriptions.data.pending_update.subscription_items.subscriptionstring

          The subscription this subscription_item belongs to.

        • subscriptions.data.pending_update.subscription_items.tax_ratesnullable array of objects

          The tax rates which apply to this subscription_item. When set, the default_tax_rates on the subscription do not apply to this subscription_item.

          Hide child attributes

          • subscriptions.data.pending_update.subscription_items.tax_rates.idstring

            Unique identifier for the object.

          • subscriptions.data.pending_update.subscription_items.tax_rates.objectstring

            String representing the object’s type. Objects of the same type share the same value.

          • subscriptions.data.pending_update.subscription_items.tax_rates.activeboolean

            Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

          • subscriptions.data.pending_update.subscription_items.tax_rates.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • subscriptions.data.pending_update.subscription_items.tax_rates.createdtimestamp

            Time at which the object was created. Measured in seconds since the Unix epoch.

          • subscriptions.data.pending_update.subscription_items.tax_rates.descriptionnullable string

            An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

          • subscriptions.data.pending_update.subscription_items.tax_rates.display_namestring

            The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

          • subscriptions.data.pending_update.subscription_items.tax_rates.effective_percentagenullable float

            Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

          • subscriptions.data.pending_update.subscription_items.tax_rates.flat_amountnullable object

            The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

            Hide child attributes

            • subscriptions.data.pending_update.subscription_items.tax_rates.flat_amount.amountinteger

              Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

            • subscriptions.data.pending_update.subscription_items.tax_rates.flat_amount.currencystring

              Three-letter ISO currency code, in lowercase.

          • subscriptions.data.pending_update.subscription_items.tax_rates.inclusiveboolean

            This specifies if the tax rate is inclusive or exclusive.

          • subscriptions.data.pending_update.subscription_items.tax_rates.jurisdictionnullable string

            The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

          • subscriptions.data.pending_update.subscription_items.tax_rates.jurisdiction_levelnullable enum

            The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

            Possible enum values

            city

            country

            county

            district

            multiple

            state

          • subscriptions.data.pending_update.subscription_items.tax_rates.livemodeboolean

            Has the value true if the object exists in live mode or the value false if the object exists in test mode.

          • subscriptions.data.pending_update.subscription_items.tax_rates.metadatanullable object

            Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

          • subscriptions.data.pending_update.subscription_items.tax_rates.percentagefloat

            Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

          • subscriptions.data.pending_update.subscription_items.tax_rates.rate_typenullable enum

            Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.

            Possible enum values

            flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

            percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

          • subscriptions.data.pending_update.subscription_items.tax_rates.statenullable string

            ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

          • subscriptions.data.pending_update.subscription_items.tax_rates.tax_typenullable enum

            The high-level tax type, such as vat or sales_tax.

            Possible enum values

            amusement_tax Amusement Tax

            communications_tax Communications Tax

            gst Goods and Services Tax

            hst Harmonized Sales Tax

            igst Integrated Goods and Services Tax

            jct Japanese Consumption Tax

            lease_tax Chicago Lease Tax

            pst Provincial Sales Tax

            qst Quebec Sales Tax

            retail_delivery_fee Retail Delivery Fee

            Show 4 more

      • subscriptions.data.pending_update.trial_endnullable timestamp

        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.

      • subscriptions.data.pending_update.trial_from_plannullable boolean

        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 to learn more.

    • subscriptions.data.schedulenullable stringExpandable

      The schedule attached to the subscription

    • subscriptions.data.start_datetimestamp

      Date when the subscription was first created. The date might differ from the created date due to backdating.

    • subscriptions.data.statusenum

      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. 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, 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.

    • subscriptions.data.test_clocknullable stringExpandable

      ID of the test clock this subscription belongs to.

    • subscriptions.data.transfer_datanullable objectConnect only

      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.

      Hide child attributes

      • subscriptions.data.transfer_data.amount_percentnullable float

        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.

      • subscriptions.data.transfer_data.destinationstringExpandable

        The account where funds from the payment will be transferred to upon payment success.

    • subscriptions.data.trial_endnullable timestamp

      If the subscription has a trial, the end of that trial.

    • subscriptions.data.trial_settingsnullable object

      Settings related to subscription trials.

      Hide child attributes

      • subscriptions.data.trial_settings.end_behaviorobject

        Defines how the subscription should behave when the user’s free trial ends.

        Hide child attributes

        • subscriptions.data.trial_settings.end_behavior.missing_payment_methodenum

          Indicates how the subscription should change when the trial ends if the user did not provide a payment method.

          Possible enum values

          cancel Cancel the subscription if a payment method is not attached when the trial ends.

          create_invoice Create an invoice when the trial ends, even if the user did not set up a payment method.

          pause Pause the subscription if a payment method is not attached when the trial ends.

    • subscriptions.data.trial_startnullable timestamp

      If the subscription has a trial, the beginning of that trial.

  • subscriptions.has_moreboolean

    True if this list has another page of items after this one that can be fetched.

  • subscriptions.urlstring

    The URL where this list can be accessed.

• tax_exemptnullable enum

  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”.

  Possible enum values

  exempt

  none

  reverse

• tax_idsnullable objectExpandable

  The customer’s tax IDs.

  Hide child attributes

  • tax_ids.objectstring

    String representing the object’s type. Objects of the same type share the same value. Always has the value list.

  • tax_ids.dataarray of objects

    Details about each object.

    Hide child attributes

    • tax_ids.data.idstring

      Unique identifier for the object.

    • tax_ids.data.objectstring

      String representing the object’s type. Objects of the same type share the same value.

    • tax_ids.data.countrynullable string

      Two-letter ISO code representing the country of the tax ID.

    • tax_ids.data.createdtimestamp

      Time at which the object was created. Measured in seconds since the Unix epoch.

    • tax_ids.data.customernullable stringExpandable

      ID of the customer.

    • tax_ids.data.livemodeboolean

      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • tax_ids.data.ownernullable object

      The account or customer the tax ID belongs to.

      Hide child attributes

      • tax_ids.data.owner.accountnullable stringExpandable

        The account being referenced when type is account.

      • tax_ids.data.owner.applicationnullable stringExpandable

        The Connect Application being referenced when type is application.

      • tax_ids.data.owner.customernullable stringExpandable

        The customer being referenced when type is customer.

      • tax_ids.data.owner.typeenum

        Type of owner referenced.

        Possible enum values

        account Indicates an account is being referenced.

        application Indicates an application is being referenced.

        customer Indicates a customer is being referenced.

        self Indicates that the account being referenced is the account making the API request.

    • tax_ids.data.typeenum

      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, gb_vat, ge_vat, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_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, 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

      Possible enum values

      ad_nrt

      ae_trn

      al_tin

      am_tin

      ao_tin

      ar_cuit

      au_abn

      au_arn

      aw_tin

      az_tin

      Show 101 more

    • tax_ids.data.valuestring

      Value of the tax ID.

    • tax_ids.data.verificationnullable object

      Tax ID verification information.

      Hide child attributes

      • tax_ids.data.verification.statusenum

        Verification status, one of pending, verified, unverified, or unavailable.

        Possible enum values

        pending

        unavailable

        unverified

        verified

      • tax_ids.data.verification.verified_addressnullable string

        Verified address.

      • tax_ids.data.verification.verified_namenullable string

        Verified name.

  • tax_ids.has_moreboolean

    True if this list has another page of items after this one that can be fetched.

  • tax_ids.urlstring

    The URL where this list can be accessed.

• test_clocknullable stringExpandable

  ID of the test clock that this customer belongs to.