Skip to content
FlowPayraFlowPayra Docs

cancel subscription

POST
/v1/subscriptions/{id}/cancel
curl --request POST \
  --url https://api.flowpayra.com/v1/subscriptions/example/cancel \
  --header 'Idempotency-Key: example' \
  --header 'X-Api-Key: <X-Api-Key>' \
  --header 'X-Nonce: <X-Nonce>' \
  --header 'X-Signature: <X-Signature>' \
  --header 'X-Timestamp: <X-Timestamp>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters <= 128 characters

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 1 characters <= 128 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
id
required
string
>= 1 characters <= 128 characters
status
required
string
>= 1 characters <= 64 characters
amount
required
string
<= 128 characters /^(0|[1-9][0-9]*)(\.[0-9]+)?$/
interval_secs
required
integer format: int64
currency_id
required
string
>= 1 characters <= 128 characters
currency_chain_id
required
string
>= 1 characters <= 128 characters
chain_id
required
string
>= 1 characters <= 128 characters
next_bill_at
required
One of:
string format: date-time
Examplegenerated
{
  "id": "example",
  "status": "example",
  "amount": "example",
  "interval_secs": 1,
  "currency_id": "example",
  "currency_chain_id": "example",
  "chain_id": "example",
  "next_bill_at": "2026-04-15T12:00:00Z"
}

400

Section titled “400”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

401

Section titled “401”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

404

Section titled “404”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

409

Section titled “409”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}

422

Section titled “422”

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
  "code": "example",
  "message": "example",
  "details": "example"
}