Developers
Recurring series

Update a recurring series header

PATCH
/recurring-series/{ref}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

ref*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/recurring-series/string" \  -H "Content-Type: application/json" \  -d '{    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",    "currency": "string",    "frequency": "monthly",    "start_date": "string",    "end_date": "string",    "issue_timing": {      "mode": "start-of-period"    }  }'
{  "object": "recurring_series",  "id": "string",  "external_id": "string",  "customer_id": "string",  "currency": "string",  "frequency": "monthly",  "start_date": "string",  "end_date": "string",  "issue_timing": {    "mode": "start-of-period"  },  "status": "draft",  "cancelled_at": "string",  "lines": [    {      "product_id": "string",      "recognition_method": "value",      "agreed_value": 0,      "hourly_rate": 0,      "discount": 0,      "description_override": "string",      "position": -9007199254740991,      "assignees": [        {          "user_id": "string",          "distribution_percentage": 0,          "hourly_rate_override": 0        }      ]    }  ]}