create subscription

POST

/v1/subscriptions

curl --request POST \
  --url https://api.flowpayra.com/v1/subscriptions \
  --header 'Content-Type: application/json' \
  --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>' \
  --data '{ "currency_id": "example", "chain_id": "example", "amount": "example", "interval_secs": 1, "splits": [ { "type": "percentage", "merchant_id": "example", "bps": 1 } ], "allowance_mode": "limited" }'

Authorizations

• HmacApiKey
• HmacSignature
• HmacTimestamp
• HmacNonce

Parameters

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

currency_id

required

string

>= 1 characters <= 128 characters

chain_id

required

string

>= 1 characters <= 128 characters

amount

required

string

<= 128 characters /^(0|[1-9][0-9]*)(\.[0-9]+)?$/

interval_secs

required

integer format: int64

>= 1

splits

Array

>= 1 items <= 32 items

One of: discriminator: type

object

object

type

required

Allowed value: percentage

merchant_id

required

string

>= 1 characters <= 128 characters

bps

required

integer format: int32

>= 1 <= 10000

object

object

type

required

Allowed value: fixed

merchant_id

required

string

>= 1 characters <= 128 characters

amounts

required

object

>= 1 properties

key

additional properties

string

<= 128 characters /^(0|[1-9][0-9]*)(\.[0-9]+)?$/

allowance_mode

string

Allowed values: limited unlimited

Responses

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

string format: date-time

null

null

authorize_url

required

string format: uri

Example^generated

{
  "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",
  "authorize_url": "https://example.com"
}

400

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

401

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

404

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

409

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

422

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}