KYkyshi
Subscriptions

Charge subscription

Changed on

Charges a subscription immediately rather than waiting for its next scheduled cycle.

post/v1/subscriptions/charge

Request

Request body

subscriptionIdstring required
paymentMethod'card' | 'mobile_money' | 'bank_transfer' | 'bank'
redirectUrlstring

Example request

{
  "subscriptionId": "sub_7f2f9170",
  "paymentMethod": "card",
  "redirectUrl": "https://merchant.example.com/subscriptions/return"
}

Response

Success.

statusboolean required

true on success.

messagestring required
codenumber required

Mirrors the HTTP status code.

Example response

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {}
}

Changes

  • 4aed77604588Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status