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/Update/Get Response

PreviousUpdate Customer SubscriptionNextRecurring payments

Last updated 2 years ago

Response is same for create, update and get requests.

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

Response example:

{
  "id": 54,
  "status": "approved",
  "customer_id": 908,
  "subscription_id": 597,
  "active_from": "2023-02-12",
  "active_to": "2023-03-12",
  "next_charge_date": "2023-02-13"
}

status

enum

String

approved, invalid-request or error

id

predefined

Integer

Subscription id

name

1-255

String

Name

message

-

String

OPTIONAL - available if status is error or invalid-request

customer_id

predefined

Integer

Customer id

subscription_id

predefined

Integer

Subscription id

next_charge_date

YYYY-MM-DD

Date

Subscription's next charge date

active_from

YYYY-MM-DD

Date

A date from which subscription is active for a customer

active_to

YYYY-MM-DD

Date

A date to which subscription is active for a customer