Temporary endpoint to create a gifted subscription.
The initial payment will be skipped for a gifted subscription and
subscription will become active immediately after the successful response.
In case the customer already has an active subscription for the
same plan - no gifted subscription will be created, error response
will be returned. Only recurrent_id payment option is supported.
Color theme of checkout for the hosted payment mode
string
Allowed values: white dark
locale
Locale of checkout for the hosted payment mode
string
Allowed values: UK EN ES PL FR SK DE
account_number
string
ip_address
string format: ipv4
fingerprint
object
browser_accept_header
required
string
browser_color_depth
required
string
browser_ip_address
required
string
browser_java_enabled
required
string
browser_language
required
string
browser_screen_height
required
string
browser_screen_width
required
string
browser_time_zone
required
string
browser_time_zone_offset
required
string
browser_user_agent
required
string
delegate_api_key
Project API key to delegate recurrent payments to.
string format: uuid
Example
5c226db4-c088-43f5-8d7a-809ac3718d66
description
Description for the subscription.
string
Example
My subscription description
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
plan_id
required
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.
In case the price is not specified or has value of 0, plan price will be used instead.
integer format: decimal
Example
3000
recurrent_id
The recurrent id for the subscription payments.
string format: number
Example
593292035525113984
result_url
required
The URL where user will be redirected after successful payment.
string format: url
Example
https://redirect-after-successful-payment.url
start_date
required
The start date of the subscription.
Date-time should be specified in RFC3339 format, UTC timezone.
string format: date-time
Example
2025-07-14T10:12:04Z
trial_periods
The amount of trial periods assigned to the subscription.
number format: integer
Example
2
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
unified_external_id
Identifier to link the subscription within partner system. Currently used by Rozetka only.
string
Example
5e4d3c2b1a
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.
HTTP call with subscription and payment data is performed when subscription is updated.
When an event isn’t related to a payment, the payment field may be omitted.
payment.processed - the initial or renew payment for the subscription has been successfully processed,
subscription has switched to the active state.
For the initial payment the subscription.start_date param is on the same date with the payment.processed_at.
For the renew payment the subscription.start_date param is on the prior date relative to payment.processed_at.
The subscription callback field holds the subscription state prior to the successful payment.
payment.failed - the initial or renew payment has failed. The rules of determining the initial or renew
payment is the same as for the payment.processed event type. Initial subscription payment failure is final,
it permanently switches the corresponding subscription to the inactive state. Instead, the renew payments
do a retry attempt once a day for 3 days after next_payment_date. During the renew payment retries
subscription.is_retrying param is set to true.
After 3 failed renew payment attempts the subscription is deactivated.
subscription.deactivated - the subscription has been deactivated. The reason for deactivation can be either the
disabled auto_renew param at the time of next_payment_date or when the all 3 renew payment attempts have failed.
subscription.renewed - a subscription started a new billing cycle after the successfull renew payment.
The subscription callback field holds the subscription state after the successful payment.
subscription.cancelled - a subscription was cancelled manually by support.
subscription.refunded - the last payment for a subscription was refunded after subscription was cancelled.
The event is sent only when the subscription was previously cancelled with the refund option enabled.
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
3000
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
2
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
payment
object
details
object
amount
Payment amount in main currency units.
For example, value of 30 equals 30 UAH payment amount.
integer format: decimal
Example
3000
created_at
Payment creation date-time in RFC3339 format.
Time is returned in UTC timezone.
Immutable.
string format: date-time
Example
2025-07-12T12:00:03Z
currency
Currency in ISO 4217 format.
string
Example
UAH
description
Description for the plan.
string
Example
My payment description
next_processing_date
Date-time of next payment processing attempt in RFC3339 format.
Time is returned in UTC timezone.
string format: date-time
Example
2025-07-12T12:00:03Z
processed_at
Date-time of payment processing completion in RFC3339 format.
Time is returned in UTC timezone.
string format: date-time
Example
2025-07-12T12:00:03Z
retry_count
The count of payment retries performed after failed first attempt.
Last date-time of payment data update in RFC3339 format.
Time is returned in UTC timezone.
string format: date-time
Example
2025-07-14T12:00:03Z
id
Payment identifier.
string format: uuid
Example
a62a18e6-d44f-4a50-bc10-34853e109fe3
subscription_id
Subscription identifier.
string format: uuid
Example
9aed5896-a829-400f-bd3b-5b6f8508de6b
user_action
Object which contains information about required post-request action. Will be null if action not required.
object
type
value
Action value. Usually it’s a checkout url or 3ds verification url.
string
subscription
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
3000
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
2
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.