Create or update subscription product
Create a new or update an existing subscription product.
PATH:
/v1/clients/{clientId}/subscription-products/{subscriptionProductId}
PATH PARAMETERS:
clientId required
|
integer
Your assigned |
subscriptionProductId required
|
string
Id of the subscription product to retrieve. |
HYPERMEDIA CONTROLS:
REQUEST BODY SCHEMA:
details object
Details of the subscription product. |
|||||||||||||||||||||||||
|
|||||||||||||||||||||||||
period object
Describes a period of the subscription product. |
|||||||||||||||||||||||||
|
|||||||||||||||||||||||||
array of items
no description in swagger file |
|||||||||||||||||||||||||
|
|||||||||||||||||||||||||
termsAndConditions object
The terms and conditions of this subscription product. |
|||||||||||||||||||||||||
|
|||||||||||||||||||||||||
available object
When this subscription product is available. |
|||||||||||||||||||||||||
|
|||||||||||||||||||||||||
trial object
Optional. Trial period that will run before the product's normal periods. |
|||||||||||||||||||||||||
|
|||||||||||||||||||||||||
financing object
no description in swagger file |
|||||||||||||||||||||||||
|
RESPONSES:
RESPONSE SCHEMA:
details object
Details of the subscription product. |
|||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||
period |
undefined
no description in swagger file |
||||||||||||||||||||||||||
array of items
no description in swagger file |
|||||||||||||||||||||||||||
Array () [
] |
|||||||||||||||||||||||||||
termsAndConditions object
The terms and conditions of this subscription product. |
|||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||
available object
When this subscription product is available. |
|||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||
trial object
Optional. Trial period that will run before the product's normal periods. |
|||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||
financing object
no description in swagger file |
|||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||
id |
string
Id of this subscription product. |
||||||||||||||||||||||||||
createdAt |
string date-time
When this subscription product was created. |
||||||||||||||||||||||||||
array of _links
List of hypermedia links related to this resource. |
|||||||||||||||||||||||||||
Array () [
] |
RESPONSE SCHEMA:
details object
Details of the subscription product. |
|||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||
period |
undefined
no description in swagger file |
||||||||||||||||||||||||||
array of items
no description in swagger file |
|||||||||||||||||||||||||||
Array () [
] |
|||||||||||||||||||||||||||
termsAndConditions object
The terms and conditions of this subscription product. |
|||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||
available object
When this subscription product is available. |
|||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||
trial object
Optional. Trial period that will run before the product's normal periods. |
|||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||
financing object
no description in swagger file |
|||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||
id |
string
Id of this subscription product. |
||||||||||||||||||||||||||
createdAt |
string date-time
When this subscription product was created. |
||||||||||||||||||||||||||
array of _links
List of hypermedia links related to this resource. |
|||||||||||||||||||||||||||
Array () [
] |
RESPONSE SCHEMA:
undefinedRESPONSE 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:
|
title |
string
A short, human-readable summary of the problem. |
message |
string
A short, human-readable summary of the problem. Identical to |
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:
|
title |
string
A short, human-readable summary of the problem. |
message |
string
A short, human-readable summary of the problem. Identical to |
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:
|
title |
string
A short, human-readable summary of the problem. |
message |
string
A short, human-readable summary of the problem. Identical to |
Path
/v1/clients/{clientId}/subscription-products/{subscriptionProductId}
Request samples
- {
- "details": { ... },
- "period": { ... },
- "items": [ ... ],
- "termsAndConditions": { ... },
- "available": { ... },
- "trial": { ... },
- "financing": { ... }
- }
Response samples
200201400401403500- {
- "id": "string",
- "period": X,
- "items": [ ... ],
- "createdAt": "string",
- "_links": [ ... ]
- {
- "id": "string",
- "period": X,
- "items": [ ... ],
- "createdAt": "string",
- "_links": [ ... ]
- {
- "type": "string",
- "category": "string",
- "title": "string",
- "message": "string"
- {
- "type": "string",
- "category": "string",
- "title": "string",
- "message": "string"
- {
- "type": "string",
- "category": "string",
- "title": "string",
- "message": "string"