Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Billing Settings v2

Billing Settings is the centralized location for configuring the various settings for billing related objects.

Learn more about calling API v2 endpoints.
Endpoints

The CollectionSetting object 

Attributes

  • idstring

    The ID of the CollectionSetting.

  • objectstring, value is "v2.billing.collection_setting"

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

  • collection_methodnullable enum

    Either automatic, or send_invoice. When charging automatically, Stripe will attempt to pay this bill at the end of the period using the payment method attached to the payer profile. When sending an invoice, Stripe will email your payer profile an invoice with payment instructions. Defaults to automatic.

    Possible enum values
    automatic

    Automatically charge for collection.

    send_invoice

    Send invoice for collection.

  • createdtimestamp

    Timestamp of when the object was created.

  • display_namenullable string

    An optional field for adding a display name for the CollectionSetting object.

  • latest_versionstring

    The latest version of the current settings object. This will be Updated every time an attribute of the settings is updated.

  • live_versionstring

    The current live version of the settings object. This can be different from latest_version if settings are updated without setting live_version=‘latest’.

  • livemodeboolean

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

  • lookup_keynullable string

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

  • payment_method_configurationnullable string

    The ID of the PaymentMethodConfiguration object, which controls which payment methods are displayed to your customers.

  • payment_method_optionsnullable object

    Payment Method specific configuration stored on the object.

The CollectionSetting object
{
  "id": "bclset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI",
  "object": "v2.billing.collection_setting",
  "collection_method": "automatic",
  "created": "2025-01-01T10:00:00.000Z",
  "display_name": "Automatic tax settings",
  "latest_version": "bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum",
  "live_version": "bclsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum"
}

The BillSetting object 

Attributes

  • idstring

    The ID of the BillSetting object.

  • objectstring, value is "v2.billing.bill_setting"

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

  • calculationnullable object

    Settings related to calculating a bill.

  • createdtimestamp

    Timestamp of when the object was created.

  • display_namenullable string

    An optional field for adding a display name for the BillSetting object.

  • invoicenullable object

    Settings related to invoice behavior.

  • invoice_rendering_templatenullable string

    The ID of the invoice rendering template to be used when generating invoices.

  • latest_versionstring

    The latest version of the current settings object. This will be Updated every time an attribute of the settings is updated.

  • live_versionstring

    The current live version of the settings object. This can be different from latest_version if settings are updated without setting live_version=‘latest’.

  • livemodeboolean

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

  • lookup_keynullable string

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

The BillSetting object
{
  "id": "bblset_test_61SIqALsEreXk4vb616S0Sp34rSQ5rdid9OCzVKXYQrI",
  "object": "v2.billing.bill_setting",
  "calculation": {
    "tax": {
      "type": "automatic"
    }
  },
  "created": "2025-01-01T10:00:00.000Z",
  "display_name": "Automatic tax settings",
  "latest_version": "bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum",
  "live_version": "bblsetv_test_61SIqALNs1R6M7aU416S0Sp34rSQ5rdid9OCzVKXYIum"
}

The BillSettingVersion object 

Attributes

  • idstring

    The ID of the BillSettingVersion object.

  • objectstring, value is "v2.billing.bill_setting_version"

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

  • calculationnullable object

    Settings related to calculating a bill.

  • createdtimestamp

    Timestamp of when the object was created.

  • invoicenullable object

    Settings related to invoice behavior.

  • invoice_rendering_templatenullable string

    The ID of the invoice rendering template to be used when generating invoices.

  • livemodeboolean

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

The BillSettingVersion object
{
  "calculation": {
    "tax": {
      "type": "automatic"
    }
  },
  "created": "2025-01-01T00:00:00.000Z",
  "id": "4242",
  "invoice": {
    "time_until_due": {
      "interval": "day",
      "interval_count": 4242
    }
  },
  "invoice_rendering_template": "4242",
  "object": "4242",
  "livemode": true
}

The CollectionSettingVersion object 

Attributes

  • idstring

    The ID of the CollectionSettingVersion object.

  • objectstring, value is "v2.billing.collection_setting_version"

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

  • collection_methodnullable enum

    Either automatic, or send_invoice. When charging automatically, Stripe will attempt to pay this bill at the end of the period using the payment method attached to the payer profile. When sending an invoice, Stripe will email your payer profile an invoice with payment instructions. Defaults to automatic.

    Possible enum values
    automatic

    Automatically charge for collection.

    send_invoice

    Send invoice for collection.

  • createdtimestamp

    Timestamp of when the object was created.

  • livemodeboolean

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

  • payment_method_configurationnullable string

    The ID of the PaymentMethodConfiguration object, which controls which payment methods are displayed to your customers.

  • payment_method_optionsnullable object

    Payment Method specific configuration stored on the object.

The CollectionSettingVersion object
{
  "collection_method": "automatic",
  "created": "2025-01-01T00:00:00.000Z",
  "id": "4242",
  "object": "4242",
  "payment_method_configuration": "4242",
  "payment_method_options": {
    "acss_debit": {
      "mandate_options": {
        "transaction_type": "business"
      },
      "verification_method": "automatic"
    },
    "bancontact": {
      "preferred_language": "de"
    },
    "card": {
      "mandate_options": {
        "amount": 4242,
        "amount_type": "fixed",
        "description": "4242"
      },
      "network": "4242",
      "request_three_d_secure": "any"
    },
    "customer_balance": {
      "bank_transfer": {
        "eu_bank_transfer": {
          "country": "BE"
        },
        "type": "eu_bank_transfer"
      },
      "funding_type": "bank_transfer"
    },
    "konbini": {},
    "sepa_debit": {},
    "us_bank_account": {
      "financial_connections": {
        "filters": {
          "account_subcategories": [
            "checking"
          ]
        },
        "permissions": [
          "balances"
        ],
        "prefetch": [
          "balances"
        ]
      },
      "verification_method": "automatic"
    }
  },
  "livemode": true
}