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

---

RuStore::PayClient::BillingSubscription

Информация о подписке, оформленной в 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) Конструктор.

Public Properties

	Name
PurchaseId	purchaseId — Идентификатор покупки.
InvoiceId	invoiceId — Идентификатор счёта.
OrderId?	orderId — Уникальный идентификатор оплаты, сформированный приложением (необязательный параметр). Если вы укажете этот параметр в вашей системе, вы получите его в ответе при работе с API. Если не укажете, он будет сгенерирован автоматически (uuid). Максимальная длина 150 символов.
Description	description — Описание на языке language.
DateTime?	purchaseTime — Время покупки (необязательный параметр).
Price	price — Цена в минимальных единицах (например в копейках).
AmountLabel	amountLabel — Отформатированная цена покупки, включая валютный знак.
Currency	currency — Код валюты ISO 4217.
DeveloperPayload?	developerPayload — Строка с дополнительной информацией о заказе, которую вы можете установить при инициализации процесса покупки (необязательный параметр).
bool	sandbox — Определяет, является ли платёж тестовым. Значения могут быть true или false, где true обозначает тестовый платёж, а false – реальный.
ProductId	productId — Идентификатор продукта, который был присвоен продукту в консоли RuStore.
DateTime?	expirationDate — Дата окончания срока действия подписки.
bool	gracePeriodEnabled — Флаг, указывающий, активен ли льготный период для подписки.
SubscriptionToken	subscriptionToken — Токен для серверной валидации покупки подписки.

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
)

Конструктор.

Parameters:

• purchaseId Идентификатор покупки.
• invoiceId Идентификатор счёта.
• orderId Уникальный идентификатор оплаты, сформированный приложением (необязательный параметр). Если вы укажете этот параметр в вашей системе, вы получите его в ответе при работе с API. Если не укажете, он будет сгенерирован автоматически (uuid). Максимальная длина 150 символов.
• purchaseType Тип покупки.
• status Состояние подписки.
• description Описание на языке language.
• purchaseTime Время покупки (необязательный параметр).
• price Цена в минимальных единицах (например в копейках).
• amountLabel Отформатированная цена покупки, включая валютный знак.
• currency Код валюты ISO 4217.
• developerPayload Строка с дополнительной информацией о заказе, которую вы можете установить при инициализации процесса покупки (необязательный параметр).
• sandbox Определяет, является ли платёж тестовым. Значения могут быть true или false, где true обозначает тестовый платёж, а false – реальный.
• expirationDate Дата окончания срока действия подписки.
• gracePeriodEnabled Флаг, указывающий, активен ли льготный период для подписки.
• subscriptionToken Токен для серверной валидации покупки подписки.

property purchaseId

PurchaseId purchaseId;

Идентификатор покупки.

property invoiceId

InvoiceId invoiceId;

Идентификатор счёта.

property orderId

OrderId? orderId;

Уникальный идентификатор оплаты, сформированный приложением (необязательный параметр). Если вы укажете этот параметр в вашей системе, вы получите его в ответе при работе с API. Если не укажете, он будет сгенерирован автоматически (uuid). Максимальная длина 150 символов.

property purchaseType

PurchaseType purchaseType;

Тип покупки.

property status

SubscriptionPurchaseStatus status;

Состояние подписки.

property description

Description description;

Описание на языке language.

property purchaseTime

DateTime? purchaseTime;

Время покупки (необязательный параметр).

property price

Price price;

Цена в минимальных единицах (например в копейках).

property amountLabel

AmountLabel amountLabel;

Отформатированная цена покупки, включая валютный знак.

property currency

Currency currency;

Код валюты ISO 4217.

property developerPayload

DeveloperPayload? developerPayload;

Строка с дополнительной информацией о заказе, которую вы можете установить при инициализации процесса покупки (необязательный параметр).

property sandbox

bool sandbox;

Определяет, является ли платёж тестовым. Значения могут быть true или false, где true обозначает тестовый платёж, а false – реальный.

property productId

ProductId productId;

property expirationDate

DateTime? expirationDate;

Дата окончания срока действия подписки.

property gracePeriodEnabled

bool gracePeriodEnabled;

Флаг, указывающий, активен ли льготный период для подписки.

property subscriptionToken

SubscriptionToken subscriptionToken;

Токен для серверной валидации покупки подписки.

---