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

---

RuStore::PayClient::BillingSubscription

Information about a subscription issued in the SDK Billing Client.

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

Public Functions

Name

BillingSubscription(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, SubscriptionToken subscriptionToken) 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 language.
DateTime?	purchaseTime — Purchase time (optional parameter).
Price	price — Price in minimum units (e.g., cents).
AmountLabel	amountLabel — Formatted purchase price including currency symbol.
Currency	currency — ISO 4217 currency code.
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 a real one.
ProductId	productId —
DateTime?	expirationDate — Subscription expiration date.
bool	gracePeriodEnabled — A flag indicating whether the grace period is enabled for the subscription.
SubscriptionToken	subscriptionToken — Token for server validation of the subscription purchase.

Additional inherited members

Public Functions inherited from RuStore.PayClient.BaseFields

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

function BillingSubscription

BillingSubscription(
    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,
    SubscriptionToken subscriptionToken
)

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 – Subscription status.
• description – Description in the language language.
• purchaseTime – Purchase time (optional parameter).
• price – Price in minimum units (e.g., cents).
• amountLabel – Formatted purchase price including currency symbol.
• currency – ISO 4217 currency code.
• 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 a real one.
• productId – Product identifier assigned to the product in the RuStore console.
• expirationDate – Subscription expiration date.
• gracePeriodEnabled – A flag indicating whether the grace period is enabled for the subscription.
• subscriptionToken – Token for server validation of the subscription purchase.

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;

Subscription status.

property description

Description description;

Description in the language language.

property purchaseTime

DateTime? purchaseTime;

Purchase time (optional parameter).

property price

Price price;

Price in minimum units (e.g., cents).

property amountLabel

AmountLabel amountLabel;

Formatted purchase price including currency symbol.

property currency

Currency currency;

ISO 4217 currency code.

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 a real one.

property productId

ProductId productId;

property expirationDate

DateTime? expirationDate;

Subscription expiration date.

property gracePeriodEnabled

bool gracePeriodEnabled;

A flag indicating whether the grace period is enabled for the subscription.

property subscriptionToken

SubscriptionToken subscriptionToken;

Token for server validation of the subscription purchase.

---