riverty logo

Docs

Create Multiple Periods

Path

POST /v1/clients/{clientId}/partner-subscriptions/{subscriptionId}/periods

Request Parameters

Idempotency-Key
string
The `idempotency-key` header is an optional field that can be included in requests to ensure request idempotence. This key serves as a unique identifier for each request, preventing the same request from being processed multiple times. For best practices, it's recommended to use UUIDs (Universally Unique Identifiers) as idempotency keys.
clientId
required
integer
Your assigned `ClientId`.
subscriptionId
required
string
Id of the subscription.

Request Body

application/json

array

Responses

Successful Request

Request Example

    
        {
 "periods": [
  {
   "periodId": "string",
   "start": "2023-10-04",
   "end": "2023-10-04",
   "price": {
    "grossAmount": 0,
    "vatPercentage": 50
   }
  }
 ]
}

Response Example

    
        {
 "periods": [
  {
   "periodId": "string",
   "status": "NOT_INVOICED",
   "start": "2023-10-04",
   "end": "2023-10-04",
   "price": {
    "grossAmount": 0,
    "vatPercentage": 50,
    "currencyCode": "string"
   }
  }
 ]
}