Skip to main content
POST
/
api
/
v2
/
subscriptions
Create
curl --request POST \
  --url https://gateway.paybyrd.com/api/v2/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "personId": 10,
  "isoAmount": 1000,
  "currency": "EUR",
  "orderRef": "AMZ1962",
  "productDescription": "Spider-Man HQ subscription",
  "intervalType": "monthly",
  "interval": 1,
  "startDate": "1962-08-15",
  "endDate": "2082-08-15",
  "timeZone": "Europe/Berlin"
}
'
{
  "code": "BYRD200",
  "description": "Operation successfully completed",
  "operationStatus": "Success",
  "subscriptionId": "435483a2-78b5-49e3-8f37-cd1c18834e02",
  "isoAmount": 1000,
  "currency": "EUR",
  "orderRef": "AMZ1962",
  "productDescription": "Spider-Man HQ subscription",
  "intervalType": "monthly",
  "interval": 1,
  "startDate": "1962-08-15",
  "endDate": "2082-08-15",
  "timeZone": "Europe/Berlin",
  "checkoutUrl": "https://link.paybyrd.com/sub_Kr6ZKx8uD"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
currency
string
required

Valid ISO-4217 alpha code e.g EUR

​
interval
integer<int32>
required
​
intervalType
enum<string>
required
Available options:
daily,
weekly,
monthly,
yearly
​
isoAmount
integer<int64>
required

The value of the recurring in ISO format (in cents).

​
productDescription
string
required

The product description that recurring is referred.

​
startDate
string<date>
required

Defines the start of recurring

​
endDate
string<date>

Defines the end of recurring

​
orderRef
string

The merchant's order reference related with the recurring.

​
timeZone
string

The recurrence timezone, normally associated with the subscriber timezone

Response

201 - application/json

201

​
code
enum<string>

Represents the Paybyrd code of the web request. To see more details check in Return Codes [blocked] page.

Available options:
BYRD010,
BYRD200,
BYRD201,
BYRD203,
BYRD205,
BYRD206,
BYRD207,
BYRD208,
BYRD230,
BYRD231,
BYRD240,
BYRD290,
BYRD291,
BYRD292,
BYRD294,
BYRD299,
BYRD401,
BYRD403,
BYRD900,
BYRD901,
BYRD999
Example:

"BYRD200"

​
description
enum<string>

Represents a textually the description of the Paybyrd code of the web request. To see more details check in Return Codes [blocked] page

Available options:
Request accepted,
Operation successfully completed,
Payment being processed. Waiting for shopper,
An error occurred while processing the payment. Please query the transaction to confirm its status,
Operation rejected,
Operation blocked by velocity,
Pending redirect,
Payment canceled by the shopper,
Payment already refunded,
The refund amount exceeds the remaining balance of the original payment,
Token is expired,
An error occurred while pre processing the transaction. Please review your request and try again,
An error occurred during while preparing transaction for acquiring. Please review your request and try again,
No payment methods available for this operation. Please contact Paybyrd's support,
Transaction could not be updated. Please review your request and try again,
Operation could not be completed. Please review your request and try again,
Resource access is forbidden,
Resource access unauthorized,
Invalid input,
Resource not found,
Operation failed
Example:

"Operation successfully completed"

​
subscriptionId
string

This field contains the unique identifier that represents the created recurring.

Example:

"e034b994-1c2b-4550-bb59-7891abe41617"

​
operationStatus
string
Example:

"Success"

​
currency
string

Valid ISO-4217 alpha code e.g EUR

​
endDate
string<date>

Defines the end of recurring

​
interval
integer<int32>
​
intervalType
enum<string>
Available options:
daily,
weekly,
monthly,
yearly
​
isoAmount
integer<int64>

The value of the recurring in ISO format (in cents).

​
orderRef
string

The merchant's order reference related with the recurring.

​
productDescription
string

The product description that recurring is referred.

​
startDate
string<date>

Defines the start of recurring

​
timeZone
string

The recurrence timezone, normally associated with the subscriber timezone

​
checkoutUrl
string

The redirect URL to proceed with the payment via Paybyrd Checkout.