Recurring series
Cancel a recurring series by setting its end date
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 POST "https://example.com/recurring-series/string/cancel" \ -H "Content-Type: application/json" \ -d '{}'{ "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 } ] } ], "discarded": true, "credit_notes": [ { "id": "string", "invoice_id": "string", "kind": "full", "amount": 0, "status": "queued" } ], "dropped_occurrences": [ { "period": "string", "period_from": "string", "period_to": "string", "work_registrations": -9007199254740991 } ]}