Documentation
  • Documentation
  • Requirements
    • API Settings
  • Web SDKs and APIs
    • Components
    • Form (redirect)
      • Introduction
        • Demo Client (Test Client)
        • 3D Secure
      • Variables - names, lengths and formats
        • How to calculate digest
        • Supported Card Issuers
        • Form Rules
        • Installments
        • Tokenize Brands
        • Custom Params
        • Custom Attributes
        • Supported Payment Methods
        • Transaction Types
      • Notifications
    • LightBox
  • eCommerce Plugins
    • WooCommerce
    • Magento
    • Prestashop
  • Mobile SDKs
  • API Documentation
    • API v1
      • Direct API
      • Transaction management
    • API v2
      • Requirements - API v2
      • Payment API
      • Pay By Link API
      • Payment Method API
      • Token API
      • Customers API
      • Card on File Payment
      • Subscriptions
        • Create Subscription
        • Update Subscription
        • Create/Update/Get Response
      • Customer Subscription
        • Create Customer Subscription
        • Update Customer Subscription
        • Create/Update/Get Response
      • Recurring payments
    • Notifications
    • List of response codes
  • WebRisk
  • 🟣Knowledge Center
    • Payments
    • WebPay Account
Powered by GitBook
On this page
  1. API Documentation
  2. API v2
  3. Customer Subscription

Create Customer Subscription

PreviousCustomer SubscriptionNextUpdate Customer Subscription

Last updated 2 years ago

Request

To create a Customer Subscription you'll need to provide:

  • Required fields (described below)

Request endpoint details

name
value
description
name
value
description
name
value
description

Request body:

field
length
type
required
description
field
length
type
required
description
field
length
type
required
description
field
length
type
required
description
field
length
type
required
description

path

/v2/customer-subscriptions

This path is used for create action

method

POST

We are creating resource, hence POST method

headers

Content-Type: application/json Accept: application/json

Specify both headers

subscription_id

predefined

Integer

YES

Subscription id. You need to create a subscription before creating customer subscription.

customer_id

predefined

Integer

YES

Customer's id. You need to create a customer before creating customer subscription.

next_charge_date

predefined

Date

YES

Date, eg: 2022-02-12. Next charge date is a date when we will charge customer. If charge is successful then next charge date is current charge date + period (ie in a week)

active_from

predefined

Date

YES

Defines a date from which a customer subscription is active. It should be before next_charge_date

active_to

predefined

Date

YES

Defines a date until which a customer subscription is active. It should be before after active_from and after next_charge_date

Create/Update/Get Response
Valid Authorization header