Subscription - Create

Creates a subscription that requires separate confirmation.

POST /subscriptions/create

Try it

Subscription - Create

cURL

curl --request POST \
  --url https://sandbox.hyperswitch.io/subscriptions/create \
  --header 'Content-Type: application/json' \
  --header 'X-Profile-Id: <x-profile-id>' \
  --header 'api-key: <api-key>' \
  --data '{
  "customer_id": "cust_123456789",
  "item_price_id": "standard-plan-USD-Monthly",
  "payment_details": {
    "authentication_type": "no_three_ds",
    "capture_method": "automatic",
    "return_url": "https://google.com",
    "setup_future_usage": "off_session"
  }
}'

200

{
  "id": "<string>",
  "status": "active",
  "profile_id": "<string>",
  "merchant_id": "<string>",
  "customer_id": "<string>",
  "merchant_reference_id": "<string>",
  "plan_id": "<string>",
  "item_price_id": "<string>",
  "client_secret": "<string>",
  "coupon_code": "<string>",
  "payment": {
    "payment_id": "<string>",
    "status": "succeeded",
    "amount": 123,
    "currency": "AED",
    "profile_id": "<string>",
    "connector": "<string>",
    "payment_method_id": "pm_01926c58bc6e77c09e809964e72af8c8",
    "return_url": "<string>",
    "next_action": {
      "redirect_to_url": "<string>",
      "type": "redirect_to_url"
    },
    "payment_experience": "redirect_to_url",
    "error_code": "<string>",
    "error_message": "<string>",
    "payment_method_type": "ach",
    "client_secret": "<string>",
    "billing": {
      "address": {
        "city": "New York",
        "country": "AF",
        "line1": "123, King Street",
        "line2": "Powelson Avenue",
        "line3": "Bridgewater",
        "zip": "08807",
        "state": "New York",
        "first_name": "John",
        "last_name": "Doe",
        "origin_zip": "08807"
      },
      "phone": {
        "number": "9123456789",
        "country_code": "+1"
      },
      "email": "<string>"
    },
    "shipping": {
      "address": {
        "city": "New York",
        "country": "AF",
        "line1": "123, King Street",
        "line2": "Powelson Avenue",
        "line3": "Bridgewater",
        "zip": "08807",
        "state": "New York",
        "first_name": "John",
        "last_name": "Doe",
        "origin_zip": "08807"
      },
      "phone": {
        "number": "9123456789",
        "country_code": "+1"
      },
      "email": "<string>"
    },
    "payment_type": "normal",
    "payment_token": "token_sxJdmpUnpNsJk5VWzcjl"
  },
  "invoice": {
    "id": "<string>",
    "subscription_id": "<string>",
    "merchant_id": "<string>",
    "profile_id": "<string>",
    "merchant_connector_id": "<string>",
    "customer_id": "<string>",
    "amount": 123,
    "currency": "AED",
    "status": "invoice_created",
    "payment_intent_id": "<string>",
    "payment_method_id": "pm_01926c58bc6e77c09e809964e72af8c8",
    "billing_processor_invoice_id": "<string>"
  }
}

Authorizations

api-key · string · header · required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Headers

X-Profile-Id · string · required

Profile ID for authentication

Body

application/json

Request payload for creating a subscription.

This struct captures details required to create a subscription, including plan, profile, merchant connector, and optional customer info.

item_price_id · string · required

Identifier for the associated item_price_id for the subscription.

customer_id · string · required

A type for customer_id that can be used for customer ids

payment_details · object · required

Show child attributes

payment_details. return_url · string · required

The url to which user must be redirected to after completion of the purchase

payment_details. setup_future_usage · enum<string>

Specifies how the payment method can be used for future payments.

• off_session: The payment method can be used for future payments when the customer is not present.
• on_session: The payment method is intended for use only when the customer is present during checkout. If omitted, defaults to on_session.

Available options: off_session, on_session

payment_details. capture_method · enum<string>

Specifies how the payment is captured.

• automatic: Funds are captured immediately after successful authorization. This is the default behavior if the field is omitted.
• manual: Funds are authorized but not captured. A separate request to the /payments/{payment_id}/capture endpoint is required to capture the funds.

Available options: automatic, manual, manual_multiple, scheduled, sequential_automatic

payment_details. authentication_type · enum<string>

Specifies the type of cardholder authentication to be applied for a payment.

• ThreeDs: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.
• NoThreeDs: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.

Note: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.

Available options: three_ds, no_three_ds

payment_details. payment_type · enum<string>

The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.

Available options: normal, new_mandate, setup_mandate, recurring_mandate

merchant_reference_id · string | null

Merchant specific Unique identifier.

plan_id · string | null

Identifier for the subscription plan.

coupon_code · string | null

Optional coupon code applied to the subscription.

billing · object

Show child attributes

billing. address · object

Address details

Show child attributes

billing.address. city · string | null

The city, district, suburb, town, or village of the address.

Maximum string length: 50

Example:

"New York"

billing.address. country · enum<string>

Available options: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, US

billing.address. line1 · string | null

The first line of the street address or P.O. Box.

Maximum string length: 200

Example:

"123, King Street"

billing.address. line2 · string | null

The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).

Maximum string length: 50

Example:

"Powelson Avenue"

billing.address. line3 · string | null

The third line of the street address, if applicable.

Maximum string length: 50

Example:

"Bridgewater"

billing.address. zip · string | null

The zip/postal code for the address

Maximum string length: 50

Example:

"08807"

billing.address. state · string | null

The address state

Example:

"New York"

billing.address. first_name · string | null

The first name for the address

Maximum string length: 255

Example:

"John"

billing.address. last_name · string | null

The last name for the address

Maximum string length: 255

Example:

"Doe"

billing.address. origin_zip · string | null

The zip/postal code of the origin

Maximum string length: 50

Example:

"08807"

billing. phone · object

Show child attributes

billing.phone. number · string | null

The contact number

Example:

"9123456789"

billing.phone. country_code · string | null

The country code attached to the number

Example:

"+1"

billing. email · string | null

shipping · object

Show child attributes

shipping. address · object

Address details

Show child attributes

shipping.address. city · string | null

The city, district, suburb, town, or village of the address.

Maximum string length: 50

Example:

"New York"

shipping.address. country · enum<string>

Available options: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, US

shipping.address. line1 · string | null

The first line of the street address or P.O. Box.

Maximum string length: 200

Example:

"123, King Street"

shipping.address. line2 · string | null

The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).

Maximum string length: 50

Example:

"Powelson Avenue"

shipping.address. line3 · string | null

The third line of the street address, if applicable.

Maximum string length: 50

Example:

"Bridgewater"

shipping.address. zip · string | null

The zip/postal code for the address

Maximum string length: 50

Example:

"08807"

shipping.address. state · string | null

The address state

Example:

"New York"

shipping.address. first_name · string | null

The first name for the address

Maximum string length: 255

Example:

"John"

shipping.address. last_name · string | null

The last name for the address

Maximum string length: 255

Example:

"Doe"

shipping.address. origin_zip · string | null

The zip/postal code of the origin

Maximum string length: 50

Example:

"08807"

shipping. phone · object

Show child attributes

shipping.phone. number · string | null

The contact number

Example:

"9123456789"

shipping.phone. country_code · string | null

The country code attached to the number

Example:

"+1"

shipping. email · string | null

Response

200

application/json

Subscription created successfully

Response payload returned after successfully creating a subscription.

Includes details such as subscription ID, status, plan, merchant, and customer info.

id · string · required

A type for subscription_id that can be used for subscription ids

status · enum<string> · required

Possible states of a subscription lifecycle.

• Created: Subscription was created but not yet activated.
• Active: Subscription is currently active.
• InActive: Subscription is inactive.
• Pending: Subscription is pending activation.
• Trial: Subscription is in a trial period.
• Paused: Subscription is paused.
• Unpaid: Subscription is unpaid.
• Onetime: Subscription is a one-time payment.
• Cancelled: Subscription has been cancelled.
• Failed: Subscription has failed.

Available options: active, created, in_active, pending, trial, paused, unpaid, onetime, cancelled, failed

profile_id · string · required

A type for profile_id that can be used for business profile ids

merchant_id · string · required

A type for merchant_id that can be used for merchant ids

customer_id · string · required

A type for customer_id that can be used for customer ids

merchant_reference_id · string | null

Merchant specific Unique identifier.

plan_id · string | null

Identifier for the associated subscription plan.

item_price_id · string | null

Identifier for the associated item_price_id for the subscription.

client_secret · string | null

This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK

coupon_code · string | null

Optional coupon code applied to this subscription.

payment · object

Show child attributes

payment. payment_id · string · required

A type for payment_id that can be used for payment ids

payment. status · enum<string> · required

Represents the overall status of a payment intent. The status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).

Available options: succeeded, failed, cancelled, cancelled_post_capture, processing, requires_customer_action, requires_merchant_action, requires_payment_method, requires_confirmation, requires_capture, partially_captured, partially_captured_and_capturable, partially_authorized_and_requires_capture, conflicted, expired

payment. amount · integer<int64> · required

This Unit struct represents MinorUnit in which core amount works

payment. currency · enum<string> · required

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

Available options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL

payment. profile_id · string

A type for profile_id that can be used for business profile ids

payment. connector · string | null

payment. payment_method_id · string | null

Identifier for Payment Method

Example:

"pm_01926c58bc6e77c09e809964e72af8c8"

payment. return_url · string | null

The url to which user must be redirected to after completion of the purchase

payment. next_action · object

Contains the url for redirection flow

Option 1

Show child attributes

payment.next_action. redirect_to_url · string · required

payment.next_action. type · enum<string> · required

Available options: redirect_to_url

payment. payment_experience · enum<string>

To indicate the type of payment experience that the customer would go through

Available options: redirect_to_url, invoke_sdk_client, display_qr_code, one_click, link_wallet, invoke_payment_app, display_wait_screen, collect_otp

payment. error_code · string | null

payment. error_message · string | null

payment. payment_method_type · enum<string>

Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.

Available options: ach, affirm, afterpay_clearpay, alfamart, ali_pay, ali_pay_hk, alma, amazon_pay, paysera, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, bluecode, boleto, bca_bank_transfer, bni_va, breadpay, bri_va, bhn_card_network, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eft, eps, flexiti, fps, evoucher, giropay, givex, google_pay, go_pay, gcash, ideal, interac, indomaret, klarna, kakao_pay, local_bank_redirect, mandiri_va, knet, mb_way, mobile_pay, momo, momo_atm, multibanco, online_banking_thailand, online_banking_czech_republic, online_banking_finland, online_banking_fpx, online_banking_poland, online_banking_slovakia, oxxo, pago_efectivo, permata_bank_transfer, open_banking_uk, pay_bright, payjustnow, paypal, paze, pix, pay_safe_card, przelewy24, prompt_pay, pse, red_compra, red_pagos, samsung_pay, sepa, sepa_bank_transfer, sepa_guarenteed_debit, skrill, sofort, swish, touch_n_go, trustly, twint, upi_collect, upi_intent, upi_qr, vipps, viet_qr, venmo, walley, we_chat_pay, seven_eleven, lawson, mini_stop, family_mart, seicomart, pay_easy, local_bank_transfer, mifinity, open_banking_pis, direct_carrier_billing, instant_bank_transfer, instant_bank_transfer_finland, instant_bank_transfer_poland, revolut_pay, indonesian_bank_transfer

payment. client_secret · string | null

This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK

payment. billing · object

Show child attributes

payment.billing. address · object

Address details

Show child attributes

payment.billing.address. city · string | null

The city, district, suburb, town, or village of the address.

Maximum string length: 50

Example:

"New York"

payment.billing.address. country · enum<string>

Available options: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, US

payment.billing.address. line1 · string | null

The first line of the street address or P.O. Box.

Maximum string length: 200

Example:

"123, King Street"

payment.billing.address. line2 · string | null

The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).

Maximum string length: 50

Example:

"Powelson Avenue"

payment.billing.address. line3 · string | null

The third line of the street address, if applicable.

Maximum string length: 50

Example:

"Bridgewater"

payment.billing.address. zip · string | null

The zip/postal code for the address

Maximum string length: 50

Example:

"08807"

payment.billing.address. state · string | null

The address state

Example:

"New York"

payment.billing.address. first_name · string | null

The first name for the address

Maximum string length: 255

Example:

"John"

payment.billing.address. last_name · string | null

The last name for the address

Maximum string length: 255

Example:

"Doe"

payment.billing.address. origin_zip · string | null

The zip/postal code of the origin

Maximum string length: 50

Example:

"08807"

payment.billing. phone · object

Show child attributes

payment.billing.phone. number · string | null

The contact number

Example:

"9123456789"

payment.billing.phone. country_code · string | null

The country code attached to the number

Example:

"+1"

payment.billing. email · string | null

payment. shipping · object

Show child attributes

payment.shipping. address · object

Address details

Show child attributes

payment.shipping.address. city · string | null

The city, district, suburb, town, or village of the address.

Maximum string length: 50

Example:

"New York"

payment.shipping.address. country · enum<string>

Available options: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, US

payment.shipping.address. line1 · string | null

The first line of the street address or P.O. Box.

Maximum string length: 200

Example:

"123, King Street"

payment.shipping.address. line2 · string | null

The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).

Maximum string length: 50

Example:

"Powelson Avenue"

payment.shipping.address. line3 · string | null

The third line of the street address, if applicable.

Maximum string length: 50

Example:

"Bridgewater"

payment.shipping.address. zip · string | null

The zip/postal code for the address

Maximum string length: 50

Example:

"08807"

payment.shipping.address. state · string | null

The address state

Example:

"New York"

payment.shipping.address. first_name · string | null

The first name for the address

Maximum string length: 255

Example:

"John"

payment.shipping.address. last_name · string | null

The last name for the address

Maximum string length: 255

Example:

"Doe"

payment.shipping.address. origin_zip · string | null

The zip/postal code of the origin

Maximum string length: 50

Example:

"08807"

payment.shipping. phone · object

Show child attributes

payment.shipping.phone. number · string | null

The contact number

Example:

"9123456789"

payment.shipping.phone. country_code · string | null

The country code attached to the number

Example:

"+1"

payment.shipping. email · string | null

payment. payment_type · enum<string>

The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.

Available options: normal, new_mandate, setup_mandate, recurring_mandate

payment. payment_token · string | null

Example:

"token_sxJdmpUnpNsJk5VWzcjl"

invoice · object

Show child attributes

invoice. id · string · required

A type for invoice_id that can be used for invoice ids

invoice. subscription_id · string · required

A type for subscription_id that can be used for subscription ids

invoice. merchant_id · string · required

A type for merchant_id that can be used for merchant ids

invoice. profile_id · string · required

A type for profile_id that can be used for business profile ids

invoice. merchant_connector_id · string · required

A type for merchant_connector_id that can be used for merchant_connector_account ids

invoice. customer_id · string · required

A type for customer_id that can be used for customer ids

invoice. amount · integer<int64> · required

This Unit struct represents MinorUnit in which core amount works

invoice. currency · enum<string> · required

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

Available options: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL

invoice. status · enum<string> · required

Available options: invoice_created, payment_pending, payment_pending_timeout, payment_succeeded, payment_failed, payment_canceled, invoice_paid, manual_review, voided

invoice. payment_intent_id · string

A type for payment_id that can be used for payment ids

invoice. payment_method_id · string | null

Identifier for Payment Method

Example:

"pm_01926c58bc6e77c09e809964e72af8c8"

invoice. billing_processor_invoice_id · string | null

billing processor invoice id