Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.
Cancel an unpaid one-time order
DELETE
/api/v1/billing/orders/{id}
const url = 'https://api.pitch2sale.com/api/v1/billing/orders/example';const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url https://api.pitch2sale.com/api/v1/billing/orders/example \ --header 'Authorization: Bearer <token>'Closes the workspace’s own unpaid one-time order (added yearly seats or a yearly upgrade): its status becomes expired and it is terminated at Cashfree. Nothing on the subscription changes. A payment that still arrives is never applied; it is flagged for a refund. Returns the order as GET /billing/seats/orders/{id} does. Idempotent. 404 for another workspace’s order; 409 order_not_open once it is paid or has expired. 10 billing changes per hour per organization. Owners and admins only.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Responses
Section titled “Responses”OK
Validation failed
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}Authentication required or token invalid
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}Role permission or token scope missing; OAuth app tokens are not accepted on this route
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}Rate limit exceeded
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}