Managing a Subscription

Getting Subscription Details

This request allows the retrieval of a previously configured subscription by issuing an HTTP GET request while supplying the appropriate PayConex account and subscriptionId as part of the end-point URL.

End-point: /api/v4/accounts/{account}/account-updater/subscriptions/{subscriptionId}

HTTP Method: GET

A successful response is indicated by an HTTP response code of 200. Below is an example response body containing the information of a previously configured subscription.

{
  "id": "css_d4c2c2cd09924d71abad464ac3004a17",
  "periodId": "PERIOD_1W",
  "periodDate": "2023-04-04",
  "responseFormat": "payconex",
  "enabled": true,
  "createdAt": "2023-04-04T15:40:28.459Z",
  "updatedAt": "2023-04-04T15:40:28.459Z",
  "templateRef": "string",
  "records": [
    {
      "id": "css_5cd5614dd4514735ae2d274597824c5e",
      "token": "string",
      "createdAt": "2023-04-04T15:40:28.459Z",
      "updatedAt": "2023-04-04T15:40:28.459Z",
      "type": "payconex",
      "enabled": true,
      "expiry": "1230"
    }
  ]
}

📘

A subscriptionId is returned as part of the API response after creating a subscription. For more information please see our guid onCreating Subscriptions.

Removing a Subscription

Using this end-point a request can also be sent that will remove a subscription that was previously configured. This is accomplished by issuing an HTTP DELETE request while supplying the appropriate PayConex account and subscriptionId as part of the end-point URL.

End-point: /api/v4/accounts/{account}/account-updater/subscriptions/{subscriptionId}

HTTP Method: DELETE

A successful deletion is indicated with an HTTP response code of 204.

Removing Records from a Subscription

The end-point below allows the removal of a specific record within a subscription.

This is accomplished by issuing an HTTP DELETE request while supplying the appropriate PayConex account, subscriptionId, and the recordId as part of the end-point URL.

End-point: /api/v4/accounts/{account}/account-updater/subscriptions/{subscriptionId}/records/{recordId}

HTTP Method: DELETE

A successful deletion is indicated with an HTTP response code of 204.

📘

A recordId is returned as part of the API response after creating a subscription. Form more information please see our guide onCreating Subscriptions.