Subscription

Partners must engage in discussions with support to configure the subscription product. The product configuration process entails reaching agreements on the following elements:

• Fixed Subscription Amount

• Subscription Cycle (Weekly or Monthly)

• First Repayment Date

This endpoint is specifically intended for managing products that are ongoing subscriptions. Subscription will continue until the user actively chooses to unsubscribe.

Create Subscription

post

The endpoint allows to create subscription for ongoing subscription products.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

emailstringRequired

The email of the customer.

Example: [email protected]

productCodestringRequired

The product code customer wants to subscribe to.

Example: Subscription Product

Responses

200Success

application/json

400

Customer is either not registered or not eligible for requested partner product. Please use the 'Registration Status' endpoint to get the customer registration status.

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

404

The customer does not exists.

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

post

/api/v2/partner/Subscription

HTTPcURLJavaScriptPython

POST /api/v2/partner/Subscription HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "email": "[email protected]",
  "productCode": "Subscription Product"
}

{
  "subscriptionId": "b6c68add-b016-44b0-9de6-6f2407bbb3e1",
  "paymentId": "347d6147-344b-4243-bf3a-a3785acdbbab",
  "dueDate": "2024-07-08T23:59:59.999+00:00",
  "amount": 9,
  "status": "Due"
}

Get Subscription

get

The endpoint allows to get subscription details.

Path parameters

subscriptionIdstringRequired

Responses

200Success

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

404

The subscription with given subscription id does not exists.

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

get

/api/v2/partner/Subscription/{subscriptionId}

HTTPcURLJavaScriptPython

GET /api/v2/partner/Subscription/{subscriptionId} HTTP/1.1
Host: qa-api.steadypay.co
Accept: */*

{
  "subscriptionId": "b6c68add-b016-44b0-9de6-6f2407bbb3e1",
  "paymentId": "347d6147-344b-4243-bf3a-a3785acdbbab",
  "dueDate": "2024-07-08T23:59:59.999+00:00",
  "amount": 9,
  "status": "Due"
}

---

• Once a payment is successfully made, the subscription for the next cycle will be automatically created for subscription only products.

Subscription Payment

post

Notify SteadyPay that user has made the subscription payment.

Path parameters

subscriptionIdstringRequired

Body

application/json

transactionIdanyRequiredExample: b6c68add-b016-44b0-9de6-6f2407bbb3e1

amountnumber · doubleRequiredExample: 9

Responses

200Success

No content

400

The amount paid does not match the due amount for the subscription. Please try again with the correct amount.

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

404

The subscription with given subscription id does not exists.

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

post

/api/v2/partner/Subscription/{subscriptionId}/payment

HTTPcURLJavaScriptPython

POST /api/v2/partner/Subscription/{subscriptionId}/payment HTTP/1.1
Host: qa-api.steadypay.co
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "transactionId": "b6c68add-b016-44b0-9de6-6f2407bbb3e1",
  "amount": 9
}

No content