Skip to main content
PUT
/
v0
/
billingSchedules
/
{id}
/
intervals
Replace schedule intervals
curl --request PUT \
  --url https://api.paygentic.io/v0/billingSchedules/{id}/intervals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intervals": [
    {
      "baseQuantity": "<string>",
      "billingCadence": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "orderLineItemId": "<string>",
      "itemId": "<string>",
      "priceId": "<string>",
      "description": "<string>",
      "unitPrice": "<string>",
      "quantityTransitions": [
        {
          "effectiveDate": "2023-11-07T05:31:56Z",
          "quantity": "<string>"
        }
      ],
      "billDate": "2023-11-07T05:31:56Z",
      "usageFilter": {},
      "metadata": {}
    }
  ],
  "orderLineItemId": "<string>"
}
'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "schedule_interval",
      "scheduleId": "<string>",
      "baseQuantity": "<string>",
      "quantityTransitions": [
        {
          "effectiveDate": "2023-11-07T05:31:56Z",
          "quantity": "<string>"
        }
      ],
      "billingCadence": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "orderLineItemId": "<string>",
      "itemId": "<string>",
      "priceId": "<string>",
      "description": "<string>",
      "unitPrice": "<string>",
      "billDate": "2023-11-07T05:31:56Z",
      "usageFilter": {}
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

Body

application/json
intervals
object[]
required
orderLineItemId
string

When set, scope the wipe to this line's intervals only (per-line cell-edit path)

Response

Intervals replaced

object
enum<string>
required
Available options:
list
data
object[]
required
pagination
object
required

Offset-based pagination response.