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, AcknowledgementState acknowledgementState) 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 you do not specify it, it will be generated automatically (uuid). Maximum length 150 characters.
Description	description — Description in the language specified by ‘language’.
DateTime?	purchaseTime — Purchase time (optional parameter).
Price	price — Price in minimum units (for example, in kopecks).
AmountLabel	amountLabel — Formatted purchase price including currency symbol.
Currency	currency — Currency code ISO 4217.
DeveloperPayload?	developerPayload — A string with additional order information that you can set when initializing the purchase process (optional parameter).
bool	sandbox — Determines whether the payment is a test. Values can be true or false, where true indicates a test payment and false indicates a real one.
ProductId	productId — Product identifier 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,
    AcknowledgementState acknowledgementState
)

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 you do not specify it, it will be generated automatically (uuid). Maximum length 150 characters.
• purchaseType Purchase type.
• status Purchase status.
• description Description in the language specified by ‘language’.
• purchaseTime Purchase time (optional parameter).
• price Price in minimum units (for example, in kopecks).
• amountLabel Formatted purchase price including currency symbol.
• currency Currency code ISO 4217.
• developerPayload A string with additional order information that you can set when initializing the purchase process (optional parameter).
• sandbox Determines whether the payment is a test. Values can be true or false, where true indicates a test payment and false indicates a real one.
• expirationDate Subscription expiration date.
• gracePeriodEnabled Flag indicating whether the grace period for the subscription is active.
• acknowledgementState Purchase acknowledgement state.

property purchaseId

PurchaseId purchaseId;

Purchase identifier.

property invoiceId

InvoiceId invoiceId;

Invoice identifier.

property orderId

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 you do not specify it, it will be generated automatically (uuid). Maximum length 150 characters.

property purchaseType

PurchaseType purchaseType;

Purchase type.

property status

SubscriptionPurchaseStatus status;

Purchase status.

property description

Description description;

Description in the language specified by ‘language’.

property purchaseTime

DateTime? purchaseTime;

Purchase time (optional parameter).

property price

Price price;

Price in minimum units (for example, in kopecks).

property amountLabel

AmountLabel amountLabel;

Formatted purchase price including currency symbol.

property currency

Currency currency;

Currency code ISO 4217.

property developerPayload

DeveloperPayload? developerPayload;

A string with additional order information that you can set when initializing the purchase process (optional parameter).

property sandbox

bool sandbox;

Determines whether the payment is a test. Values can be true or false, where true indicates a test payment and false indicates a real one.

property productId

ProductId productId;

Product identifier assigned to the product in the RuStore console.

property expirationDate

DateTime? expirationDate;

Subscription expiration date.

property gracePeriodEnabled

bool gracePeriodEnabled;

Flag indicating whether the grace period for the subscription is active.

property acknowledgementState

AcknowledgementState acknowledgementState;

Purchase acknowledgement state.