List Subscriptions

GET /subscriptions

Try it

Parameters

siteCode*querystatusquerylimitqueryoffsetqueryX-Correlation-IDheader

Request sampleLanguage

curl -X GET 'https://one.ozow.com/v1/subscriptions?siteCode=string&status=Active&limit=50&offset=0' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'X-Correlation-ID: 00000000-0000-0000-0000-000000000000'

Response exampleStatus

{
  "links": {
    "self": "https://one.ozow.com/v1/payments?siteCode=SITE-001&fromDate=2026-01-01&toDate=2026-01-31&limit=50&offset=50",
    "first": "https://one.ozow.com/v1/payments?siteCode=SITE-001&fromDate=2026-01-01&toDate=2026-01-31&limit=50&offset=0",
    "last": "https://one.ozow.com/v1/payments?siteCode=SITE-001&fromDate=2026-01-01&toDate=2026-01-31&limit=50&offset=100",
    "prev": "https://one.ozow.com/v1/payments?siteCode=SITE-001&fromDate=2026-01-01&toDate=2026-01-31&limit=50&offset=0",
    "next": "https://one.ozow.com/v1/payments?siteCode=SITE-001&fromDate=2026-01-01&toDate=2026-01-31&limit=50&offset=100"
  },
  "results": [
    {
      "subscriptionId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Active",
      "siteCode": "ABC-123456789",
      "amount": {
        "currency": "ZAR",
        "value": 50
      },
      "amountConstraints": {
        "min": {
          "currency": "ZAR",
          "value": 50
        },
        "max": {
          "currency": "ZAR",
          "value": 50
        }
      },
      "payableNow": {
        "amount": {
          "currency": "ZAR",
          "value": 50
        },
        "date": "2026-06-25"
      },
      "description": "Monthly plan",
      "merchantReference": "SUB-0001",
      "bankReference": "MyStore",
      "frequency": "Monthly",
      "firstPaymentDate": "2026-07-01",
      "occurrences": 12,
      "redirectUrl": "https://example.com/redirecturl",
      "authorization": {
        "status": "<status>"
      },
      "links": {
        "self": "https://example.com/self",
        "cancel": "https://example.com/cancel",
        "transactions": "https://example.com/transactions"
      }
    }
  ],
  "meta": {
    "totalPages": 1,
    "totalItems": 1
  }
}

Built from the response schema. Values are placeholders, not real data.

GEThttps://one.ozow.com/v1/subscriptionsProduction

List subscriptions for a site. The siteCode query parameter is required.

Authentication

OAuth 2.0
scopessubscriptions

Query parameters

siteCode string required
The merchant site code.
status string
Filter the results by subscription status.
values"PendingAuthorization""Active""Canceled""Completed""Expired""Failed""Unknown"
limit integer
The maximum number of items to return.
min1max50default50
offset integer
The number of items to discard in this paging operation.
min length0min0default0

Header parameters

X-Correlation-ID string
Optional correlation id for the request, if not supplied a new one will be generated and passed onto all underlying requests and returned as a header.

Responses

200 OK

X-Correlation-ID header
The correlation id for the request that was processed.

links PaginationLinks required
The links used in pagination.
Fields of PaginationLinks
- self string uri
  The current page of data.
- first string uri
  The first page of data.
- last string uri nullable
  The last page of data. Null when the whole collection fits on one page.
- prev string uri nullable
  The previous page of data. Null on the first page.
- next string uri nullable
  The next page of data. Null on the last page.
Open PaginationLinks on its own page
results array of SubscriptionResponse required
Fields of SubscriptionResponse
- subscriptionId string required
  The unique identifier of the subscription.
- status SubscriptionStatus required
  The lifecycle status of a subscription:
  
  PendingAuthorization - created, awaiting customer authorisation via redirectUrl.
  
  Active - authorised; scheduled charges are being taken.
  
  Canceled - cancelled; no further charges.
  
  Completed - all scheduled occurrences have been taken.
  
  Expired - the authorisation lapsed before activation.
  
  Failed - the subscription could not be established or sustained.
  
  Unknown - the status could not be determined.
  values"PendingAuthorization""Active""Canceled""Completed""Expired""Failed""Unknown"
- siteCode string required
  The site code the subscription belongs to.
- amount Amount required
  The recurring charge amount.
  Fields of Amount
  currency string required
  The ISO 4217 current code.
  min length3max length3
  value number float required
  The amount in the currency specified.
  min0.01
  Open Amount on its own page
- amountConstraints AmountConstraints
  The authorised per-payment band. Returned on create and get.
  Fields of AmountConstraints
  min Amount required
  The minimum authorised per-payment amount. Whole Rand, greater than 0.
  Fields of Amount
  currency string required
  The ISO 4217 current code.
  min length3max length3
  value number float required
  The amount in the currency specified.
  min0.01
  Open Amount on its own page
  max Amount required
  The maximum authorised per-payment amount. Whole Rand, greater than min, and not exceeding 100000.
  Fields of Amount
  currency string required
  The ISO 4217 current code.
  min length3max length3
  value number float required
  The amount in the currency specified.
  min0.01
  Open Amount on its own page
  Open AmountConstraints on its own page
- payableNow PayableNow
  The once-off sign-up charge. Returned on create only.
  Fields of PayableNow
  amount Amount required
  The once-off charge amount. Must be ZAR.
  Fields of Amount
  currency string required
  The ISO 4217 current code.
  min length3max length3
  value number float required
  The amount in the currency specified.
  min0.01
  Open Amount on its own page
  date string date required
  The date the once-off charge is taken. Must be today or a future date.
  Open PayableNow on its own page
- description string
  The subscription description.
- merchantReference string required
  Your reference for the subscription.
- bankReference string
  The reference that appears on the merchant's bank statement for each payment in the subscription.
- frequency SubscriptionFrequency
  The billing cadence of a subscription.
  values"Daily""Weekly""Fortnightly""Monthly""Biannually""Annually"
- firstPaymentDate string date required
  The date of the first scheduled charge.
- occurrences integer required
  The total number of scheduled charges.
- redirectUrl string uri
  The hosted authorisation page the customer must be redirected to in order to approve the subscription. Present while authorisation is pending.
- authorization object
  The customer's authorisation (consent) status. Populated once the customer has authorised via redirectUrl.
  - status string
    The provider-mirrored authorisation status.
- links object required
  Related resource links for the subscription.
  - self string uri
    The URI of this subscription.
  - cancel string uri
    The URI to cancel this subscription.
  - transactions string uri
    The URI to create an ad-hoc charge against this subscription.
Open SubscriptionResponse on its own page
meta PaginationMeta
Fields of PaginationMeta
- totalPages integer required
  The total number of pages available.
- totalItems integer required
  The total number of items available.
Open PaginationMeta on its own page

400 Bad Request.

X-Correlation-ID header
The correlation id for the request that was processed.

id string uuid required
a unique identifier for this particular occurrence of the problem.
links object nullable
Present on an authentication or authorisation failure, and null otherwise.
- about string uri
  A link that leads to further details about this particular occurrence of the problem. When derefenced, this URI SHOULD return a human-readable description of the error.
- type string uri
  A link that identifies the type of error that this particular error is an instance of. This URI SHOULD be dereferencable to a human-readable explanation of the general error.
code string required
An application-specific error code, expressed as a string value. Key on this rather than on title or detail, which are written for a person. A rejection at the transport level uses the status name, one of BadRequest, Unauthorized, Forbidden, NotFound, NotAllowed, Conflict, UnsupportedMediaType, BadGateway or InternalServerError. An operation refusing a request on its own rules returns a code of its own.
title string required
A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string required
A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
source object nullable
Where in the request the problem was found. All three keys are present whenever source is, with the ones that do not apply set to null. source itself is null where the failure is not about a part of the request.
- pointer string json-pointer nullable
  a JSON Pointer RFC6901 to the value in the request document that caused the error [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute]. This MUST point to a value in the request document that exists; if it doesn’t, the client SHOULD simply ignore the pointer.
- parameter string nullable
  A string indicating which URI query parameter caused the error.
- header string nullable
  A string indicating the name of a single request header which caused the error.
meta object nullable
A meta object containing non-standard meta-information about the error. Null where the request carried no X-Correlation-ID, and on an authentication failure, which does not echo it.
- correlationId string
  The X-Correlation-ID sent with the request, echoed back so it can be quoted to support. Absent when the request carried no correlation header.

A field in the request body did not validate

{
  "id": "3a6c9e01-5f2b-4d8a-9c47-1e0b7d5a2f83",
  "links": null,
  "code": "BadRequest",
  "title": "Bad Request",
  "detail": "amount: Amount must be greater than 0",
  "source": {
    "pointer": "/amount",
    "parameter": null,
    "header": null
  },
  "meta": {
    "correlationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

401 Unauthorised.

X-Correlation-ID header
The correlation id for the request that was processed.

id string uuid required
a unique identifier for this particular occurrence of the problem.
links object nullable
Present on an authentication or authorisation failure, and null otherwise.
- about string uri
  A link that leads to further details about this particular occurrence of the problem. When derefenced, this URI SHOULD return a human-readable description of the error.
- type string uri
  A link that identifies the type of error that this particular error is an instance of. This URI SHOULD be dereferencable to a human-readable explanation of the general error.
code string required
An application-specific error code, expressed as a string value. Key on this rather than on title or detail, which are written for a person. A rejection at the transport level uses the status name, one of BadRequest, Unauthorized, Forbidden, NotFound, NotAllowed, Conflict, UnsupportedMediaType, BadGateway or InternalServerError. An operation refusing a request on its own rules returns a code of its own.
title string required
A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string required
A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
source object nullable
Where in the request the problem was found. All three keys are present whenever source is, with the ones that do not apply set to null. source itself is null where the failure is not about a part of the request.
- pointer string json-pointer nullable
  a JSON Pointer RFC6901 to the value in the request document that caused the error [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute]. This MUST point to a value in the request document that exists; if it doesn’t, the client SHOULD simply ignore the pointer.
- parameter string nullable
  A string indicating which URI query parameter caused the error.
- header string nullable
  A string indicating the name of a single request header which caused the error.
meta object nullable
A meta object containing non-standard meta-information about the error. Null where the request carried no X-Correlation-ID, and on an authentication failure, which does not echo it.
- correlationId string
  The X-Correlation-ID sent with the request, echoed back so it can be quoted to support. Absent when the request carried no correlation header.

No usable access token on the request

{
  "id": "1cecc2b7-1c29-418a-b26a-bf7546926083",
  "links": {
    "about": "https://ozow.stoplight.io/docs/one-api/zi18vomr0jm8c-generate-authentication-token",
    "type": "https://tools.ietf.org/html/rfc7235#section-3.1"
  },
  "code": "Unauthorized",
  "title": "Unauthorized Request",
  "detail": "Authorization header is missing or invalid.",
  "source": {
    "pointer": null,
    "parameter": null,
    "header": "Authorization"
  },
  "meta": null
}

404 Not found. The item with the specified identifier could not be found, or this resource is not allowed for the resource identifier.

X-Correlation-ID header
The correlation id for the request that was processed.

id string uuid required
a unique identifier for this particular occurrence of the problem.
links object nullable
Present on an authentication or authorisation failure, and null otherwise.
- about string uri
  A link that leads to further details about this particular occurrence of the problem. When derefenced, this URI SHOULD return a human-readable description of the error.
- type string uri
  A link that identifies the type of error that this particular error is an instance of. This URI SHOULD be dereferencable to a human-readable explanation of the general error.
code string required
An application-specific error code, expressed as a string value. Key on this rather than on title or detail, which are written for a person. A rejection at the transport level uses the status name, one of BadRequest, Unauthorized, Forbidden, NotFound, NotAllowed, Conflict, UnsupportedMediaType, BadGateway or InternalServerError. An operation refusing a request on its own rules returns a code of its own.
title string required
A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string required
A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
source object nullable
Where in the request the problem was found. All three keys are present whenever source is, with the ones that do not apply set to null. source itself is null where the failure is not about a part of the request.
- pointer string json-pointer nullable
  a JSON Pointer RFC6901 to the value in the request document that caused the error [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute]. This MUST point to a value in the request document that exists; if it doesn’t, the client SHOULD simply ignore the pointer.
- parameter string nullable
  A string indicating which URI query parameter caused the error.
- header string nullable
  A string indicating the name of a single request header which caused the error.
meta object nullable
A meta object containing non-standard meta-information about the error. Null where the request carried no X-Correlation-ID, and on an authentication failure, which does not echo it.
- correlationId string
  The X-Correlation-ID sent with the request, echoed back so it can be quoted to support. Absent when the request carried no correlation header.

No resource with that identifier

{
  "id": "5b9e3c17-4a8d-42f0-9e61-3c7b0f2a8d15",
  "links": null,
  "code": "NotFound",
  "title": "Not Found",
  "detail": "The requested resource was not found.",
  "source": {
    "pointer": "/data",
    "parameter": "/v1/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "header": null
  },
  "meta": {
    "correlationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

502 Bad Gateway. An upstream payment service was unreachable or returned an error; the request was not completed. Safe to retry shortly.

X-Correlation-ID header
The correlation id for the request that was processed.

id string uuid required
a unique identifier for this particular occurrence of the problem.
links object nullable
Present on an authentication or authorisation failure, and null otherwise.
- about string uri
  A link that leads to further details about this particular occurrence of the problem. When derefenced, this URI SHOULD return a human-readable description of the error.
- type string uri
  A link that identifies the type of error that this particular error is an instance of. This URI SHOULD be dereferencable to a human-readable explanation of the general error.
code string required
An application-specific error code, expressed as a string value. Key on this rather than on title or detail, which are written for a person. A rejection at the transport level uses the status name, one of BadRequest, Unauthorized, Forbidden, NotFound, NotAllowed, Conflict, UnsupportedMediaType, BadGateway or InternalServerError. An operation refusing a request on its own rules returns a code of its own.
title string required
A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string required
A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
source object nullable
Where in the request the problem was found. All three keys are present whenever source is, with the ones that do not apply set to null. source itself is null where the failure is not about a part of the request.
- pointer string json-pointer nullable
  a JSON Pointer RFC6901 to the value in the request document that caused the error [e.g. "/data" for a primary data object, or "/data/attributes/title" for a specific attribute]. This MUST point to a value in the request document that exists; if it doesn’t, the client SHOULD simply ignore the pointer.
- parameter string nullable
  A string indicating which URI query parameter caused the error.
- header string nullable
  A string indicating the name of a single request header which caused the error.
meta object nullable
A meta object containing non-standard meta-information about the error. Null where the request carried no X-Correlation-ID, and on an authentication failure, which does not echo it.
- correlationId string
  The X-Correlation-ID sent with the request, echoed back so it can be quoted to support. Absent when the request carried no correlation header.

An upstream payment service could not be reached

{
  "id": "6c3a1f95-8d07-4e2b-a94c-5f0b7d2e8134",
  "links": null,
  "code": "BadGateway",
  "title": "Bad Gateway",
  "detail": "The upstream service is currently unavailable. Please try again shortly.",
  "source": null,
  "meta": {
    "correlationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Request

curl -X GET 'https://one.ozow.com/v1/subscriptions?siteCode=string&status=Active&limit=50&offset=0' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'X-Correlation-ID: 00000000-0000-0000-0000-000000000000'

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://one.ozow.com/v1/subscriptions?siteCode=string&status=Active&limit=50&offset=0");
request.Headers.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN");
request.Headers.Add("X-Correlation-ID", "00000000-0000-0000-0000-000000000000");

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://one.ozow.com/v1/subscriptions?siteCode=string&status=Active&limit=50&offset=0',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_ACCESS_TOKEN',
        'X-Correlation-ID: 00000000-0000-0000-0000-000000000000',
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

const response = await fetch("https://one.ozow.com/v1/subscriptions?siteCode=string&status=Active&limit=50&offset=0", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "X-Correlation-ID": "00000000-0000-0000-0000-000000000000",
  },
});

const data = await response.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "X-Correlation-ID": "00000000-0000-0000-0000-000000000000",
}

response = requests.get(
    "https://one.ozow.com/v1/subscriptions?siteCode=string&status=Active&limit=50&offset=0",
    headers=headers,
)

Response

{
  "links": {
    "self": "https://one.ozow.com/v1/payments?siteCode=SITE-001&fromDate=2026-01-01&toDate=2026-01-31&limit=50&offset=50",
    "first": "https://one.ozow.com/v1/payments?siteCode=SITE-001&fromDate=2026-01-01&toDate=2026-01-31&limit=50&offset=0",
    "last": "https://one.ozow.com/v1/payments?siteCode=SITE-001&fromDate=2026-01-01&toDate=2026-01-31&limit=50&offset=100",
    "prev": "https://one.ozow.com/v1/payments?siteCode=SITE-001&fromDate=2026-01-01&toDate=2026-01-31&limit=50&offset=0",
    "next": "https://one.ozow.com/v1/payments?siteCode=SITE-001&fromDate=2026-01-01&toDate=2026-01-31&limit=50&offset=100"
  },
  "results": [
    {
      "subscriptionId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Active",
      "siteCode": "ABC-123456789",
      "amount": {
        "currency": "ZAR",
        "value": 50
      },
      "amountConstraints": {
        "min": {
          "currency": "ZAR",
          "value": 50
        },
        "max": {
          "currency": "ZAR",
          "value": 50
        }
      },
      "payableNow": {
        "amount": {
          "currency": "ZAR",
          "value": 50
        },
        "date": "2026-06-25"
      },
      "description": "Monthly plan",
      "merchantReference": "SUB-0001",
      "bankReference": "MyStore",
      "frequency": "Monthly",
      "firstPaymentDate": "2026-07-01",
      "occurrences": 12,
      "redirectUrl": "https://example.com/redirecturl",
      "authorization": {
        "status": "<status>"
      },
      "links": {
        "self": "https://example.com/self",
        "cancel": "https://example.com/cancel",
        "transactions": "https://example.com/transactions"
      }
    }
  ],
  "meta": {
    "totalPages": 1,
    "totalItems": 1
  }
}

Built from the response schema. Values are placeholders, not real data.

Bad Request.

{
  "id": "3a6c9e01-5f2b-4d8a-9c47-1e0b7d5a2f83",
  "links": null,
  "code": "BadRequest",
  "title": "Bad Request",
  "detail": "amount: Amount must be greater than 0",
  "source": {
    "pointer": "/amount",
    "parameter": null,
    "header": null
  },
  "meta": {
    "correlationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Unauthorised.

{
  "id": "1cecc2b7-1c29-418a-b26a-bf7546926083",
  "links": {
    "about": "https://ozow.stoplight.io/docs/one-api/zi18vomr0jm8c-generate-authentication-token",
    "type": "https://tools.ietf.org/html/rfc7235#section-3.1"
  },
  "code": "Unauthorized",
  "title": "Unauthorized Request",
  "detail": "Authorization header is missing or invalid.",
  "source": {
    "pointer": null,
    "parameter": null,
    "header": "Authorization"
  },
  "meta": null
}

Not found. The item with the specified identifier could not be found, or this resource is not allowed for the resource identifier.

{
  "id": "5b9e3c17-4a8d-42f0-9e61-3c7b0f2a8d15",
  "links": null,
  "code": "NotFound",
  "title": "Not Found",
  "detail": "The requested resource was not found.",
  "source": {
    "pointer": "/data",
    "parameter": "/v1/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "header": null
  },
  "meta": {
    "correlationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Bad Gateway. An upstream payment service was unreachable or returned an error; the request was not completed. Safe to retry shortly.

{
  "id": "6c3a1f95-8d07-4e2b-a94c-5f0b7d2e8134",
  "links": null,
  "code": "BadGateway",
  "title": "Bad Gateway",
  "detail": "The upstream service is currently unavailable. Please try again shortly.",
  "source": null,
  "meta": {
    "correlationId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}