Developer

API references

Search documentation... ⌘K

API references

Open merchant dashboard

Merchant API

- Available API versions
- Supported payment methods
- Find key
- List keys
- Revoke key
- Update key
- Get balance
- Find bank account
- Link bank account
- Set primary contact bank account
- Unlink bank account
- List monthly billing archives
- List plans
- List statements
- Retrieve current plan
- Retrieve monthly billing archive
- Select plan
- Confirm branding upload
- Generate branding upload url
- Remove branding document
- Retrieve branding
- Retrieve branding font
- Update branding
- Find card
- Forget card
- Save card
- Set default card
- Retrieve checkout
- Start checkout
- Add contact
- List contacts
- Remove contact
- Retrieve contact
- Update contact
- Disable installation
- Enable installation
- Find installation
- List installations
- Reconfigure installation
- Remove installation
- List metadata
- Retrieve metadata
- Sync metadata
- List email subscribers
- Retrieve email subscriber
- Retrieve notification topics
- Subscribe to topics
- Unsubscribe from all topics
- Add payment link
- Clone payment link
- Disable payment link
- Enable payment link
- Filter payment links
- Find payment link
- List payment link payments
- List payment links
- Abort payment on terminal
- Capture payment
- Filter payments
- Find payment
- Initiate payment flow
- List payment activities
- List payments
- List payments by contact
- List payments by terminal
- Refund payment
- Request payment
- Retrieve sales performance
- Reverse payment
- Start payment on terminal
- Void payment
- Filter payouts
- Find payout
- List payout activities
- List payouts
- List payouts by contact
- Send payout
- Send payout to contact
- Set primary bank account
- Turn off auto payout
- Turn on auto payout
- Find refund
- List refunds by payment
- Assign role
- List permissions
- List roles
- Add terminal
- Disable terminal
- Enable terminal
- Filter terminals
- Find terminal
- List terminals
- Remove terminal
- Reset terminal
- Update terminal
- List user invitations
- List users
- Disconnect webhook
- Find webhook
- List webhooks
- Pause webhook
- Reconnect webhook
- Resume webhook

All our references

Retrieve current plan

Retrieves the current billing plan for the merchant account. This endpoint returns the plan details including the plan ID, name, tier, and any associated metadata. It is used to check the current subscription status and plan features available to the merchant.

The response includes information about the plan's tier, which indicates the level of service provided.

Endpoint signature

This endpoint requires an API key. Read our authentication guide for more information.

POST https://api.reservepay.com/merchants/retrieve-current-plan HTTP/1.1

Content-Type: application/json

Accept: application/json

Authorization: Bearer <token>

{}

Returns: object

New to Reservepay? Read our guide on how to call endpoints to get started.

Response attributes

Attribute	Description
`id` string	The unique identifier of the plan.
`tier_code` string	The code representing the tier this plan belongs to.
`tier_name` string	The name of the tier (e.g., 'Basic', 'Pro').
`features` array	List of features included in this plan.
`revision_time` string	The date and time when the plan was last revised.
`selectable` boolean	Indicates whether the plan can be selected by the merchant via self-service.

Errors specific to this endpoint


              NO_PLAN_SELECTED

The merchant is not currently subscribed to any plan. A plan must be subscribed to via the select-plan endpoint first.

Errors common to all endpoints


              UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.


              INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.


              BAD_VERSION

This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

CODE SAMPLES

curl

Learn how to run these code samples in your terminal by reading our guide.