API/Autodoc/Classes/RuStore.PayClient.SubscriptionPurchase.en.md


RuStore::PayClient::SubscriptionPurchase

Purchase information.

Inherits from RuStore.PayClient.BaseFields, RuStore.PayClient.IPurchaseStatus< SubscriptionPurchaseStatus >, RuStore.PayClient.IPurchase

Public Functions

Name
SubscriptionPurchase(PurchaseId purchaseId, InvoiceId invoiceId, OrderId? orderId, PurchaseType purchaseType, SubscriptionPurchaseStatus status, Description description, DateTime? purchaseTime, Price price, AmountLabel amountLabel, Currency currency, DeveloperPayload? developerPayload, bool sandbox, ProductId productId, DateTime? expirationDate, bool gracePeriodEnabled)
Constructor.

Public Properties

Name
PurchaseId purchaseId — Purchase identifier.
InvoiceId invoiceId — Invoice identifier.
OrderId? orderId — Unique payment identifier generated by the application (optional parameter). If you specify this parameter in your system, you will receive it in the response when working with the API. If not specified, it will be generated automatically (uuid). Maximum length 150 characters.
Description description — Description in the language language.
DateTime? purchaseTime — Purchase time (optional parameter).
Price price — Price in minimum units (e.g., kopecks).
AmountLabel amountLabel — Formatted purchase price, including currency symbol.
Currency currency — ISO 4217 currency code.
DeveloperPayload? developerPayload — String with additional order information that you can set when initializing the purchase process (optional parameter).
bool sandbox — Determines whether the payment is test. Values can be true or false, where true indicates a test payment, and false indicates a real payment.
ProductId productId — Product identifier that was assigned to the product in the RuStore console.
DateTime? expirationDate — Subscription expiration date.
bool gracePeriodEnabled — Flag indicating whether the grace period for the subscription is active.

Additional inherited members

Public Functions inherited from RuStore.PayClient.BaseFields

Name
override bool Equals(object obj)
override int GetHashCode()
override string ToString()

function SubscriptionPurchase

SubscriptionPurchase(
    PurchaseId purchaseId,
    InvoiceId invoiceId,
    OrderId? orderId,
    PurchaseType purchaseType,
    SubscriptionPurchaseStatus status,
    Description description,
    DateTime? purchaseTime,
    Price price,
    AmountLabel amountLabel,
    Currency currency,
    DeveloperPayload? developerPayload,
    bool sandbox,
    ProductId productId,
    DateTime? expirationDate,
    bool gracePeriodEnabled
)

Constructor.

Parameters:

  • purchaseId Purchase identifier.
  • invoiceId Invoice identifier.
  • orderId Unique payment identifier generated by the application (optional parameter). If you specify this parameter in your system, you will receive it in the response when working with the API. If not specified, it will be generated automatically (uuid). Maximum length 150 characters.
  • purchaseType Purchase type.
  • status Purchase status.
  • description Description in the language language.
  • purchaseTime Purchase time (optional parameter).
  • price Price in minimum units (e.g., kopecks).
  • amountLabel Formatted purchase price, including currency symbol.
  • currency ISO 4217 currency code.
  • developerPayload String with additional order information that you can set when initializing the purchase process (optional parameter).
  • sandbox Determines whether the payment is test. Values can be true or false, where true indicates a test payment, and false indicates a real payment.
  • productId Product identifier that was assigned to the product in the RuStore console.
  • expirationDate Subscription expiration date.
  • gracePeriodEnabled Flag indicating whether the grace period for the subscription is active.
Назад