Get customer subscriptions

Authorizations

Header Parameters

X-CUSTOMER-AUTH

string format: jwt

User access token.

X-CUSTOMER-RID

string format: uuid

Example

8ba5dd43-496e-4432-9c8a-74fdc74139fe

User RID identifier. RID header will be used if both are set. There is a deprecated way to call the endpoint. Please use access token with authorization_flow=processing instead if you need to do some non user-initiated action like background processing or calls from the admin.

Query Parameters

external_id

string

User ID in external system

200

Array<object>

object

auto_renew

Controls whether the subscription should automatically renew after the due date.

boolean

Example

true

auto_renew_locked_until

The next date-time when the subscription auto_renew param can be changed. The value is calculated based on duration_periods param of the corresponding subscription plan. Date-time is returned in RFC3339 format. Time is specified in UTC timezone.

string format: date-time

Example

2026-02-14T12:00:03Z

callback_url

The URL where asynchronous subscription updates will be sent.

string format: url

created_at

Subscription creation date-time in RFC3339 format. Time is returned in UTC timezone. Immutable.

string format: date-time

Example

2025-07-14T12:00:03Z

currency

Currency in ISO 4217 format.

string format: string

Example

UAH

customer_id

Customer identifier. May hold RID value.

string

Example

0ee67270-297d-4ed4-993c-5b4ba95c4daf

delegate_api_key

Project API key where recurrent payments are delegated.

string format: uuid

Example

5c226db4-c088-43f5-8d7a-809ac3718d66

description

Description for the subscription.

string

Example

My subscription description

due_date

The date until which subscription will stay active if not cancelled. Date is returned in RFC3339 format, time is omitted.

string format: date-time

Example

2025-09-14T00:00:00Z

external_id

Identifier to link the subscription within partner system. Currently used by Rozetka only.

string

Example

9i8h7g6f5e4d

external_premium_id

Identifier to link the subscription within partner system. Currently used by Rozetka only.

string

Example

1a2b3c4d5e

id

Subscription identifier.

string

Example

9aed5896-a829-400f-bd3b-5b6f8508de6b

is_retrying

Shows whether the subscription in currently retrying its renew payment.

boolean

next_notification_date

The date of next notification for the customer. Date is returned in RFC3339 format. Currently not supported.

string format: date

Example

2025-09-13T00:00:00Z

next_payment_date

The date of next payment for the subscription. Date-time is returned in RFC3339 format, time is omitted.

string format: date-time

Example

2025-09-14T00:00:00Z

plan_id

The corresponding plan identifier.

string format: uuid

Example

d38bdf4e-cbd8-46f5-87fa-538dd7618731

price

Subscription price in main currency units. For example, value of 30 equals 30 UAH subscription price.

integer format: decimal

Example

project_id

Source project for the current subscription.

string format: uuid

Example

d38bdf4e-cbd8-46f5-87fa-538dd7618731

recurrent_id

The recurrent id for the subscription payments. Optional.

string format: number

Example

573299035525213784

result_url

The URL where user will be redirected after successful payment.

string format: uri

start_date

The start date of the subscription. Date-time is returned in RFC3339 format, time is omitted.

string format: date-time

Example

2025-07-14T00:00:00Z

state

Current subscription state.

string format: string

Allowed values: init processing pending active inactive

time_of_day

The time of day component for the params that have date specified only. Date-time is returned in RFC3339 format.

string format: date-time

Example

0001-01-01T12:00:03Z

trial_periods

The amount of trial periods assigned to the subscription.

number format: integer

Example

trial_periodic_payments

Specifies, whether to apply periodic payments for trial subscription instead of single initial payment in case trial_periods value is more than one.

boolean

Example

true

trial_until

The end date-time of the subscription trial. Date-time is returned in RFC3339 format. Time is specified in UTC timezone.

string format: date-time

Example

2025-09-14T12:00:03Z

unified_external_id

Identifier to link the subscription within partner system. Currently used by Rozetka only.

string

Example

5e4d3c2b1a

updated_at

The last date-time of the subscription update. Date-time is returned in RFC3339 format.

string format: date-time

Example

2025-07-14T12:01:12Z

use_plan_price_on_auto_renew

Controls whether the subscription should use the plan price instead the of the price provided in subscription data when the automatic subscription renew is performed.

boolean

Example

true

400

object

code

string

Allowed values: authorization_failed customer_auth_not_found request_failed internal_error access_not_allowed invalid_request_body payment_settings_not_found transaction_already_paid action_not_allowed action_already_done transaction_success_primary_not_found payment_method_not_allowed wallet_not_configured payment_method_already_confirmed payment_method_not_found invalid_card_token customer_auth_token_expired_or_invalid customer_profile_not_found customer_id_not_passed transaction_not_found waiting_for_verification transaction_amount_limit invalid_data transaction_declined authorization_error transaction_rejected transaction_successful anti_fraud_check card_not_supported confirmation_timeout invalid_card_data invalid_currency pending waiting_for_complete access_error card_expired receiver_info_error transaction_limit_exceeded transaction_not_supported 3ds_not_supported 3ds_required failed_to_create_transaction failed_to_finish_transaction insufficient_funds invalid_phone_number card_has_constraints pin_tries_exceeded session_expired timeout transaction_created waiting_for_redirect wrong_amount test_transaction subscription_successful unsubscribed_successfully wrong_pin wrong_authorization_code wrong_cavv wrong_cvv wrong_account_number confirm_required cvv_is_required confirmation_required sender_info_required missed_payout_method_data card_verification_required incorrect_refund_sum_or_currency payment_card_has_invalid_status wrong_card_number user_not_found failed_to_send_sms wrong_sms_password card_not_found payment_system_not_supported country_not_supported no_discount_found failed_to_load_wallet invalid_verification_code additional_information_is_pending transaction_is_not_recurring confirm_amount_cannot_be_more_than_the_transaction_amount card_bin_not_found currency_rate_not_found invalid_recipient_name daily_card_usage_limit_reached invalid_transaction_amount card_type_is_not_supported store_is_blocked store_is_not_active payment_method_not_found transaction_cannot_be_processed invalid_transaction_status public_key_not_found terminal_not_found fee_not_found failed_to_verify_card invalid_transaction_type restricted_ip invalid_token preauth_not_allowed token_does_not_exist reached_the_limit_of_attempts_for_ip card_branch_is_blocked card_branch_daily_limit_reached completion_limit_reached recurring_transactions_not_allowed transaction_is_canceled_by_payer payment_was_refunded card_is_lost_or_stolen plan_not_found plan_not_active plan_project_missing subscription_auto_renew_locked subscription_not_found subscription_not_active subscription_already_exists order_canceled

message

string

param

string

payment_id

string

type

string

Allowed values: invalid_request_error payment_method_error payment_settings_error payment_error api_error customer_error

error_id

string

401

object

code

string

Allowed values: authorization_failed customer_auth_not_found request_failed internal_error access_not_allowed invalid_request_body payment_settings_not_found transaction_already_paid action_not_allowed action_already_done transaction_success_primary_not_found payment_method_not_allowed wallet_not_configured payment_method_already_confirmed payment_method_not_found invalid_card_token customer_auth_token_expired_or_invalid customer_profile_not_found customer_id_not_passed transaction_not_found waiting_for_verification transaction_amount_limit invalid_data transaction_declined authorization_error transaction_rejected transaction_successful anti_fraud_check card_not_supported confirmation_timeout invalid_card_data invalid_currency pending waiting_for_complete access_error card_expired receiver_info_error transaction_limit_exceeded transaction_not_supported 3ds_not_supported 3ds_required failed_to_create_transaction failed_to_finish_transaction insufficient_funds invalid_phone_number card_has_constraints pin_tries_exceeded session_expired timeout transaction_created waiting_for_redirect wrong_amount test_transaction subscription_successful unsubscribed_successfully wrong_pin wrong_authorization_code wrong_cavv wrong_cvv wrong_account_number confirm_required cvv_is_required confirmation_required sender_info_required missed_payout_method_data card_verification_required incorrect_refund_sum_or_currency payment_card_has_invalid_status wrong_card_number user_not_found failed_to_send_sms wrong_sms_password card_not_found payment_system_not_supported country_not_supported no_discount_found failed_to_load_wallet invalid_verification_code additional_information_is_pending transaction_is_not_recurring confirm_amount_cannot_be_more_than_the_transaction_amount card_bin_not_found currency_rate_not_found invalid_recipient_name daily_card_usage_limit_reached invalid_transaction_amount card_type_is_not_supported store_is_blocked store_is_not_active payment_method_not_found transaction_cannot_be_processed invalid_transaction_status public_key_not_found terminal_not_found fee_not_found failed_to_verify_card invalid_transaction_type restricted_ip invalid_token preauth_not_allowed token_does_not_exist reached_the_limit_of_attempts_for_ip card_branch_is_blocked card_branch_daily_limit_reached completion_limit_reached recurring_transactions_not_allowed transaction_is_canceled_by_payer payment_was_refunded card_is_lost_or_stolen plan_not_found plan_not_active plan_project_missing subscription_auto_renew_locked subscription_not_found subscription_not_active subscription_already_exists order_canceled

message

string

param

string

payment_id

string

type

string

Allowed values: invalid_request_error payment_method_error payment_settings_error payment_error api_error customer_error

error_id

string

404

object

code

string

Allowed values: authorization_failed customer_auth_not_found request_failed internal_error access_not_allowed invalid_request_body payment_settings_not_found transaction_already_paid action_not_allowed action_already_done transaction_success_primary_not_found payment_method_not_allowed wallet_not_configured payment_method_already_confirmed payment_method_not_found invalid_card_token customer_auth_token_expired_or_invalid customer_profile_not_found customer_id_not_passed transaction_not_found waiting_for_verification transaction_amount_limit invalid_data transaction_declined authorization_error transaction_rejected transaction_successful anti_fraud_check card_not_supported confirmation_timeout invalid_card_data invalid_currency pending waiting_for_complete access_error card_expired receiver_info_error transaction_limit_exceeded transaction_not_supported 3ds_not_supported 3ds_required failed_to_create_transaction failed_to_finish_transaction insufficient_funds invalid_phone_number card_has_constraints pin_tries_exceeded session_expired timeout transaction_created waiting_for_redirect wrong_amount test_transaction subscription_successful unsubscribed_successfully wrong_pin wrong_authorization_code wrong_cavv wrong_cvv wrong_account_number confirm_required cvv_is_required confirmation_required sender_info_required missed_payout_method_data card_verification_required incorrect_refund_sum_or_currency payment_card_has_invalid_status wrong_card_number user_not_found failed_to_send_sms wrong_sms_password card_not_found payment_system_not_supported country_not_supported no_discount_found failed_to_load_wallet invalid_verification_code additional_information_is_pending transaction_is_not_recurring confirm_amount_cannot_be_more_than_the_transaction_amount card_bin_not_found currency_rate_not_found invalid_recipient_name daily_card_usage_limit_reached invalid_transaction_amount card_type_is_not_supported store_is_blocked store_is_not_active payment_method_not_found transaction_cannot_be_processed invalid_transaction_status public_key_not_found terminal_not_found fee_not_found failed_to_verify_card invalid_transaction_type restricted_ip invalid_token preauth_not_allowed token_does_not_exist reached_the_limit_of_attempts_for_ip card_branch_is_blocked card_branch_daily_limit_reached completion_limit_reached recurring_transactions_not_allowed transaction_is_canceled_by_payer payment_was_refunded card_is_lost_or_stolen plan_not_found plan_not_active plan_project_missing subscription_auto_renew_locked subscription_not_found subscription_not_active subscription_already_exists order_canceled

message

string

param

string

payment_id

string

type

string

Allowed values: invalid_request_error payment_method_error payment_settings_error payment_error api_error customer_error

error_id

string

500

object

code

string

Allowed values: authorization_failed customer_auth_not_found request_failed internal_error access_not_allowed invalid_request_body payment_settings_not_found transaction_already_paid action_not_allowed action_already_done transaction_success_primary_not_found payment_method_not_allowed wallet_not_configured payment_method_already_confirmed payment_method_not_found invalid_card_token customer_auth_token_expired_or_invalid customer_profile_not_found customer_id_not_passed transaction_not_found waiting_for_verification transaction_amount_limit invalid_data transaction_declined authorization_error transaction_rejected transaction_successful anti_fraud_check card_not_supported confirmation_timeout invalid_card_data invalid_currency pending waiting_for_complete access_error card_expired receiver_info_error transaction_limit_exceeded transaction_not_supported 3ds_not_supported 3ds_required failed_to_create_transaction failed_to_finish_transaction insufficient_funds invalid_phone_number card_has_constraints pin_tries_exceeded session_expired timeout transaction_created waiting_for_redirect wrong_amount test_transaction subscription_successful unsubscribed_successfully wrong_pin wrong_authorization_code wrong_cavv wrong_cvv wrong_account_number confirm_required cvv_is_required confirmation_required sender_info_required missed_payout_method_data card_verification_required incorrect_refund_sum_or_currency payment_card_has_invalid_status wrong_card_number user_not_found failed_to_send_sms wrong_sms_password card_not_found payment_system_not_supported country_not_supported no_discount_found failed_to_load_wallet invalid_verification_code additional_information_is_pending transaction_is_not_recurring confirm_amount_cannot_be_more_than_the_transaction_amount card_bin_not_found currency_rate_not_found invalid_recipient_name daily_card_usage_limit_reached invalid_transaction_amount card_type_is_not_supported store_is_blocked store_is_not_active payment_method_not_found transaction_cannot_be_processed invalid_transaction_status public_key_not_found terminal_not_found fee_not_found failed_to_verify_card invalid_transaction_type restricted_ip invalid_token preauth_not_allowed token_does_not_exist reached_the_limit_of_attempts_for_ip card_branch_is_blocked card_branch_daily_limit_reached completion_limit_reached recurring_transactions_not_allowed transaction_is_canceled_by_payer payment_was_refunded card_is_lost_or_stolen plan_not_found plan_not_active plan_project_missing subscription_auto_renew_locked subscription_not_found subscription_not_active subscription_already_exists order_canceled

message

string

param

string

payment_id

string

type

string

Allowed values: invalid_request_error payment_method_error payment_settings_error payment_error api_error customer_error

error_id

string

Get customer subscriptions

Authorizations

Parameters

Header Parameters

Example

Query Parameters

Responses

200

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

400

401

404

500