---
title: "Create subscription"
method: POST
path: "/subscriptions"
tags: ["Subscriptions"]
---

# Create subscription

`POST /subscriptions`

## Headers

- `x-vfi-api-idempotencyKey` string

## Response `201`

Created

- Model21
  - `id` string, required — The PayPal-generated ID for the subscription.
  - `status` string, required — The status of the subscription.
  - `planId` string, required — The ID of the plan
  - `statusUpdateTime` string, date, required — Status update time.
  - `planOverridden` boolean, required — Indicates whether the subscription has overridden any plan attributes.
  - `quantity` string — The quantity of the product in the subscription.
  - `startTime` string, date — The quantity of the product in the subscription.
  - `shippingAmount` Model19 — Shipping charges amount
    - `value` integer, required — Integer amount value (100 is 1.00)
    - `currencyCode` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | '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' | 'MXV' | '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' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required — Currency code (ISO-4217)
  - `subscriber` Subscriber — The subscriber request information
    - `name` Name — The name of the payer
      - `givenName` string
      - `surname` string
    - `payerId` string — The PayPal-assigned ID for the payer
    - `emailAddress` string — Customer email address
    - `phone` Phone — The phone number of the customer. Available only when you enable the Contact Telephone Number option in the Profile & Settings for the merchant's PayPal account
      - `phoneType` 'FAX' | 'HOME' | 'MOBILE' | 'OTHER' | 'PAGER' — The phone type
      - `phoneNumber` PhoneNumber, required — The phone number, in its canonical international E.164 numbering plan format
        - `nationalNumber` string, required
    - `shippingAddress` Model12 — The shipping details
      - `name` Model11 — The name of the person to whom to ship the items
        - `fullName` string
      - `address` BillingAddress — Shipping Address details
        - `country` string, required — The two-character ISO 3166-1 code that identifies the country or region.
        - `postalCode` string, required — The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent.
        - `countrySubdivision` string — The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
        - `city` string — A city, town, or village. Smaller than admin_area_level_1
        - `addressLine2` string — The second line of the address. For example, suite or apartment number.
        - `addressLine1` string — The first line of the address. For example, number or street. For example, 173 Drury Lane. Required for data entry and compliance and risk checks. Must contain the full address.
  - `applicationContext` ApplicationContext — The application context, which customizes the payer experience during the subscription approval process with PayPal
    - `brandName` string — The label that overrides the business name in the PayPal account on the PayPal site
    - `locale` string — The BCP 47-formatted locale of pages that the PayPal payment experience shows. PayPal supports a five-character code. For example, da-DK, he-IL, id-ID, ja-JP, no-NO, pt-BR, ru-RU, sv-SE, th-TH, zh-CN, zh-HK, or zh-TW
    - `shippingPreference` 'GET_FROM_FILE' | 'NO_SHIPPING' | 'SET_PROVIDED_ADDRESS' — The location from which the shipping address is derived
    - `userAction` 'CONTINUE' | 'SUBSCRIBE_NOW' — Configures the label name to Continue or Subscribe Now for subscription consent experience
    - `paymentMethod` PaymentMethod — The customer and merchant payment preferences. Currently only PAYPAL payment method is supported
      - `payerSelected` string — The customer-selected payment method on the merchant site
      - `payeePreferred` 'UNRESTRICTED' | 'IMMEDIATE_PAYMENT_REQUIRED' — The merchant-preferred payment methods
    - `returnUrl` string — The URL where the customer is redirected after the customer approves the payment
    - `cancelUrl` string — The URL where the customer is redirected after the customer cancels the payment
  - `createdAt` string, date — The quantity of the product in the subscription.
  - `approvalUrl` string, required — PayPal approval URL

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/verifone/apis/checkout-api.md) · [All operations](https://skmtc.net/verifone/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verifone/checkout-api/revisions/ed8dc1f12a5a/schema)