Assinaturas

subscriptionsnamespace

Planos, assinaturas e renovações.

8métodos

subscriptionsnamespace

Esta página é gerada automaticamente pelo @luckymaker/sdk-generator. Não edite manualmente.

cancelSubscription

POST/user/subscriptions/:id/cancel

Assinatura:

cancelSubscription(id: string, body?: CancelSubscriptionBody, settings?: SdkSettings): Promise<CancelSubscriptionResponse>

Parâmetros de rota

Nome	Tipo
id	string

Body

Nome	Tipo	Obrigatório
feedback	"FINANCIAL" | "NOT_USING" | "BETTER_ALTERNATIVE" | "TOO_EXPENSIVE" | "RESUBSCRIBE_INTENT" | "OTHER"	não
comment	string	não

Tipos

type CancelSubscriptionParams = { "id": string; };
type CancelSubscriptionBody = { "feedback"?: "FINANCIAL" | "NOT_USING" | "BETTER_ALTERNATIVE" | "TOO_EXPENSIVE" | "RESUBSCRIBE_INTENT" | "OTHER"; "comment"?: string; };
type CancelSubscriptionResponse = unknown;

Exemplo

const response = await sdk.subscriptions.cancelSubscription("string", { "feedback": "FINANCIAL", "comment": "string" });

Testar esta função no playground

getPayments

GET/user/subscriptions/:id/payments

Assinatura:

getPayments(id: string, query?: GetPaymentsQuery, settings?: SdkSettings): Promise<GetPaymentsResponse>

Parâmetros de rota

Nome	Tipo
id	string

Query

Nome	Tipo	Obrigatório
page	number	não

Tipos

type GetPaymentsParams = { "id": string; };
type GetPaymentsQuery = { "page"?: number; };
type GetPaymentsResponse = unknown;

Exemplo

const response = await sdk.subscriptions.getPayments("string");

Testar esta função no playground

getPlan

GET/subscriptions/:id

Assinatura:

getPlan(id: string, settings?: SdkSettings): Promise<GetPlanResponse>

Parâmetros de rota

Nome	Tipo
id	string

Tipos

type GetPlanParams = { "id": string; };
type GetPlanResponse = { "id": string; "name": string; "description"?: null | string; "benefitsDescription": string; "benefits": Array<{ "title": string; "description": string; "icon": string; }>; "price": number; "isSelling": boolean; "timeUnit": "WEEK" | "MONTH"; "timeUnitAmount": number; "billingLabel": string; "ecommerceItemId"?: null | string; "ecommerceItem"?: null | { "id": string; "title": string; }; "thumbnail": { "url"?: null | string; }; "badges": Array<{ "type": string; "label": string; "bgColor": string; "txtColor": string; "tooltip"?: string; }>; "backgroundColor"?: null | string; "textColor"?: null | string; "rewardItems"?: Array<{ "type": "RAFFLE_NUMBERS" | "CREDITS" | "ECOMMERCE_ITEM" | "BENEFITS_CLUB_POINTS" | "SUBSCRIPTION" | "SHIPPING"; "label": string; "excerpt"?: null | string; "totalAmount": number; }>; "showcaseDiscount"?: { "offerId": string; "discountType": "FIXED" | "PERCENTAGE"; "discountValue": number; "durationCycles": number; "requiresNeverPurchasedPlan": boolean; } | null; };

Exemplo

const response = await sdk.subscriptions.getPlan("string");

Testar esta função no playground

getSubscription

GET/user/subscriptions/:id

Assinatura:

getSubscription(id: string, settings?: SdkSettings): Promise<GetSubscriptionResponse>

Parâmetros de rota

Nome	Tipo
id	string

Tipos

type GetSubscriptionParams = { "id": string; };
type GetSubscriptionResponse = unknown;

Exemplo

const response = await sdk.subscriptions.getSubscription("string");

Testar esta função no playground

getSummary

GET/user/subscriptions/summary

Assinatura:

getSummary(settings?: SdkSettings): Promise<GetSummaryResponse>

Tipos

type GetSummaryResponse = { "everSubscribedPlanIds": Array<string>; "activePlanIds": Array<string>; };

Exemplo

const response = await sdk.subscriptions.getSummary();

Testar esta função no playground

listPlans

GET/subscriptions/plans

Assinatura:

listPlans(settings?: SdkSettings): Promise<ListPlansResponse>

Tipos

type ListPlansResponse = Array<{ "id": string; "name": string; "description"?: null | string; "benefitsDescription": string; "benefits": Array<{ "title": string; "description": string; "icon": string; }>; "price": number; "isSelling": boolean; "timeUnit": "WEEK" | "MONTH"; "timeUnitAmount": number; "billingLabel": string; "ecommerceItemId"?: null | string; "ecommerceItem"?: null | { "id": string; "title": string; }; "thumbnail": { "url"?: null | string; }; "badges": Array<{ "type": string; "label": string; "bgColor": string; "txtColor": string; "tooltip"?: string; }>; "backgroundColor"?: null | string; "textColor"?: null | string; "rewardItems"?: Array<{ "type": "RAFFLE_NUMBERS" | "CREDITS" | "ECOMMERCE_ITEM" | "BENEFITS_CLUB_POINTS" | "SUBSCRIPTION" | "SHIPPING"; "label": string; "excerpt"?: null | string; "totalAmount": number; }>; "showcaseDiscount"?: { "offerId": string; "discountType": "FIXED" | "PERCENTAGE"; "discountValue": number; "durationCycles": number; "requiresNeverPurchasedPlan": boolean; } | null; }>;

Exemplo

const response = await sdk.subscriptions.listPlans();

Testar esta função no playground

listSubscriptions

GET/user/subscriptions

Assinatura:

listSubscriptions(settings?: SdkSettings): Promise<ListSubscriptionsResponse>

Tipos

type ListSubscriptionsResponse = Array<{ "id": string; "userId": number; "planId": string; "paymentId": number; "status": "PENDING_FIRST_PAYMENT" | "PENDING_RENEWAL" | "ACTIVE" | "CANCELLED" | "EXPIRED"; "optOutReason": "USER_REQUESTED" | "ADMIN_REQUESTED" | "PAYMENT_FAILED" | "AUTHORIZATION_REVOKED" | "LOST_GATEWAY_TRACKING" | null; "cancellationFeedback": "FINANCIAL" | "NOT_USING" | "BETTER_ALTERNATIVE" | "TOO_EXPENSIVE" | "RESUBSCRIBE_INTENT" | "OTHER" | null; "cancellationComment": string | null; "optedOutAt": string | null; "canReactivate": boolean; "gateway": string; "price": number; "timeUnit": "WEEK" | "MONTH"; "timeUnitAmount": number; "billingLabel": string; "nextBillingAt": string | null; "lastBillingAt"?: string | null; "createdAt": string; "updatedAt": string; "discountedPrice"?: number | null; "activeDiscounts"?: Array<{ "id": string; "sourceType": string; "discountType": "FIXED" | "PERCENTAGE"; "discountValue": number; "totalCycles": number; "remainingCycles": number; }>; "plan"?: { "id": string; "name": string; "description"?: null | string; "benefitsDescription": string; "benefits": Array<{ "title": string; "description": string; "icon": string; }>; "price": number; "isSelling": boolean; "timeUnit": "WEEK" | "MONTH"; "timeUnitAmount": number; "billingLabel": string; "ecommerceItemId"?: null | string; "ecommerceItem"?: null | { "id": string; "title": string; }; "thumbnail": { "url"?: null | string; }; "badges": Array<{ "type": string; "label": string; "bgColor": string; "txtColor": string; "tooltip"?: string; }>; "backgroundColor"?: null | string; "textColor"?: null | string; "rewardItems"?: Array<{ "type": "RAFFLE_NUMBERS" | "CREDITS" | "ECOMMERCE_ITEM" | "BENEFITS_CLUB_POINTS" | "SUBSCRIPTION" | "SHIPPING"; "label": string; "excerpt"?: null | string; "totalAmount": number; }>; "showcaseDiscount"?: { "offerId": string; "discountType": "FIXED" | "PERCENTAGE"; "discountValue": number; "durationCycles": number; "requiresNeverPurchasedPlan": boolean; } | null; }; }>;

Exemplo

const response = await sdk.subscriptions.listSubscriptions();

Testar esta função no playground

renewSubscription

POST/user/subscriptions/:id/renew

Assinatura:

renewSubscription(id: string, settings?: SdkSettings): Promise<RenewSubscriptionResponse>

Parâmetros de rota

Nome	Tipo
id	string

Tipos

type RenewSubscriptionParams = { "id": string; };
type RenewSubscriptionResponse = unknown;

Exemplo

const response = await sdk.subscriptions.renewSubscription("string");

Testar esta função no playground