Home > API > Clients > Get subscription product

Get subscription product

Get an existing subscription product.

PATH:

/v1/clients/{clientId}/subscription-products/{subscriptionProductId}

PATH PARAMETERS:

clientId
required

integer

Your assigned ClientId.
subscriptionProductId
required

string

Id of the subscription product to retrieve.

HYPERMEDIA CONTROLS:

RESPONSES:

200 Success.

RESPONSE SCHEMA:

details

details object

Details of the subscription product.
description

string <= 200 characters

A short description about the product as shown on the invoice.
productUrl

string <= 1000 characters

Optional. A URL to the subscription product's page.
imageUrl

string <= 1000 characters

Optional. A URL to the subscription product's image.
period

undefined

no description in swagger file
items

array of items

no description in swagger file
Array () [
name

string <= 100 characters

Product name
description

string <= 255 characters

Product description
price

price object

no description in swagger file
grossAmount

number decimal

The gross amount.
vatPercentage

number decimal

The VAT percentage. For a VAT of 25%, the percentage is 25.
currencyCode

string

The currency code.
metadata

array of metadata

no description in swagger file
Array () [
key

string <= 30 characters

The key of the metadata item.
value

string <= 255 characters

The value of the metadata item.

]
isRefundable

boolean

If not defined, then will be used default value 'true'
partialPeriodAmountCalculation

string

Enum: PARTIAL FULL IGNORE

no description in swagger file

]
termsAndConditions

termsAndConditions object

The terms and conditions of this subscription product.
description

string

A description of the terms and conditions.
billingType

string

Enum: IN_ADVANCE IN_ARREARS

no description in swagger file
cancellationType

string

Enum: INSTANT AFTER_CURRENT_PERIOD AFTER_NEXT_PERIOD

no description in swagger file
commitment

commitment object

Optional. Details of the commitment agreement.
numberOfPeriods

integer

How many periods the commitment lasts.
numberOfCycles

integer

How many cycles the commitment lasts. If not provided then the commitment will be indefinite.
endOfCommitmentAction

string

Enum: RENEW_COMMITMENT CONTINUE_WITHOUT_COMMITMENT CLOSE_SUBSCRIPTION

The action to take when the commitment ends.
available

available object

When this subscription product is available.
from

string date

no description in swagger file
until

string date

no description in swagger file
trial

trial object

Optional. Trial period that will run before the product's normal periods.
details

object of details

no description in swagger file
description

string <= 200 characters

a description of the trial period.
period

period object

no description in swagger file
length

string

Enum: 14_DAYS 1_MONTH

no description in swagger file
price

price object

no description in swagger file
grossAmount

number decimal

The gross amount.
vatPercentage

number decimal

The VAT percentage. For a VAT of 25%, the percentage is 25.
financing

financing object

no description in swagger file
type

string

Enum: CONTRACT BILLING

no description in swagger file
id

string

Id of this subscription product.
createdAt

string date-time

When this subscription product was created.
_links

array of _links

List of hypermedia links related to this resource.
Array () [
method

string

HTTP Method.
href

string

Link to the resource.
rel

string

The relation between the current and target resource.

]
400 Bad request.

RESPONSE SCHEMA:

undefined
401 Missing or invalid "Authorization" header.

RESPONSE SCHEMA:

type

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

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.
403 Lacking permissions.

RESPONSE SCHEMA:

type

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

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.
404 Resource not found.

RESPONSE SCHEMA:

type

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

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.
500 Unexpected internal server error.

RESPONSE SCHEMA:

type

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

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.

Path

get

/v1/clients/{clientId}/subscription-products/{subscriptionProductId}

Response samples

200400401403404500
  • {
    • "id": "string",
    • "period": X,
    • "items": [ ...
      • {
        • "price": { ...
          • "currencyCode": "string"
          }
        }
      ],
    • "createdAt": "string",
    • "_links": [ ...
      • {
        • "method": "string",
        • "href": "string",
        • "rel": "string",
        • "target": X
        }
      ]
    }
undefined
  • {
    • "type": "string",
    • "category": "string",
    • "title": "string",
    • "message": "string"
    }
  • {
    • "type": "string",
    • "category": "string",
    • "title": "string",
    • "message": "string"
    }
  • {
    • "type": "string",
    • "category": "string",
    • "title": "string",
    • "message": "string"
    }
  • {
    • "type": "string",
    • "category": "string",
    • "title": "string",
    • "message": "string"
    }