Docs

Get Prepayments

Get details related to prepayment transactions on the subscription.

Path

GET /v1/clients/{clientId}/subscriptions/{subscriptionId}/prepayment

Request Parameters

clientId

required

integer

Your assigned `ClientId`.

subscriptionId

required

string

Id of the subscription to retrieve.

Responses

type

required

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.

category

required

string

Enum:

BUSINESS_ERROR

TECHNICAL_ERROR

Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occured. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.

title

string

A short, human-readable summary of the problem.

message

string

A short, human-readable summary of the problem. Identical to `title`.

type

required

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.

category

required

string

Enum:

BUSINESS_ERROR

TECHNICAL_ERROR

Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occured. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.

title

string

A short, human-readable summary of the problem.

message

string

A short, human-readable summary of the problem. Identical to `title`.

required

array

A list of validation failures for the request.

Successful Request

Request Example

    
        null

Response Example

    
        {
 "id": "subscription-id-1",
 "productId": "subscription-product-id-1",
 "periods": [
  {
   "grossAmount": 180,
   "start": "2024-01-22",
   "end": "2024-01-31",
   "type": "PARTIAL"
  },
  {
   "grossAmount": 620,
   "start": "2024-02-01",
   "end": "2024-02-29",
   "type": "FULL"
  }
 ]
}