Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

PaymentsResellerSubscription

import { PaymentsResellerSubscription } from "https://googleapis.deno.dev/v1/paymentsresellersubscription:v1.ts";
class PaymentsResellerSubscription {
constructor(client?: CredentialsClient, baseUrl?: string);
async partnersProductsList(parent: string, opts?: PartnersProductsListOptions): Promise<GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse>;
async partnersPromotionsList(parent: string, opts?: PartnersPromotionsListOptions): Promise<GoogleCloudPaymentsResellerSubscriptionV1ListPromotionsResponse>;
async partnersSubscriptionsGet(name: string): Promise<GoogleCloudPaymentsResellerSubscriptionV1Subscription>;
}

§Constructors

§
new PaymentsResellerSubscription(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
partnersProductsList(parent: string, opts?: PartnersProductsListOptions): Promise<GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse>
[src]

Currently, it doesn't support YouTube products. Retrieves the products that can be resold by the partner. It should be autenticated with a service account.

@param parent

Required. The parent, the partner that can resell. Format: partners/{partner}

§
partnersPromotionsFindEligible(parent: string, req: GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsRequest): Promise<GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsResponse>
[src]

Currently, it is only enabeld for YouTube. Finds eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope openid is sufficient, which will skip the consent screen.

@param parent

Required. The parent, the partner that can resell. Format: partners/{partner}

§
partnersPromotionsList(parent: string, opts?: PartnersPromotionsListOptions): Promise<GoogleCloudPaymentsResellerSubscriptionV1ListPromotionsResponse>
[src]

Currently, it doesn't support YouTube promotions. Retrieves the promotions, such as free trial, that can be used by the partner. It should be autenticated with a service account.

@param parent

Required. The parent, the partner that can resell. Format: partners/{partner}

§
partnersSubscriptionsCancel(name: string, req: GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest): Promise<GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse>
[src]

Cancels a subscription service either immediately or by the end of the current billing cycle for their customers. It should be called directly by the partner using service accounts.

@param name

Required. The name of the subscription resource to be cancelled. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}"

§
partnersSubscriptionsCreate(parent: string, req: GoogleCloudPaymentsResellerSubscriptionV1Subscription, opts?: PartnersSubscriptionsCreateOptions): Promise<GoogleCloudPaymentsResellerSubscriptionV1Subscription>
[src]

Used by partners to create a subscription for their customers. The created subscription is associated with the end user inferred from the end user credentials. This API must be authorized by the end user using OAuth.

@param parent

Required. The parent resource name, which is the identifier of the partner. It will have the format of "partners/{partner_id}".

§
partnersSubscriptionsEntitle(name: string, req: GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest): Promise<GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionResponse>
[src]

Entitles a previously provisioned subscription to the current end user. The end user identity is inferred from the authorized credential of the request. This API must be authorized by the end user using OAuth.

@param name

Required. The name of the subscription resource that is entitled to the current end user. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}"

§
partnersSubscriptionsExtend(name: string, req: GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest): Promise<GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionResponse>
[src]

[Opt-in only] Most partners should be on auto-extend by default. Extends a subscription service for their customers on an ongoing basis for the subscription to remain active and renewable. It should be called directly by the partner using service accounts.

@param name

Required. The name of the subscription resource to be extended. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}".

§
partnersSubscriptionsGet(name: string): Promise<GoogleCloudPaymentsResellerSubscriptionV1Subscription>
[src]

Gets a subscription by id. It should be called directly by the partner using service accounts.

@param name

Required. The name of the subscription resource to retrieve. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}"

§
partnersSubscriptionsProvision(parent: string, req: GoogleCloudPaymentsResellerSubscriptionV1Subscription, opts?: PartnersSubscriptionsProvisionOptions): Promise<GoogleCloudPaymentsResellerSubscriptionV1Subscription>
[src]

Used by partners to provision a subscription for their customers. This creates a subscription without associating it with the end user account. EntitleSubscription must be called separately using OAuth in order for the end user account to be associated with the subscription. It should be called directly by the partner using service accounts.

@param parent

Required. The parent resource name, which is the identifier of the partner. It will have the format of "partners/{partner_id}".

§
partnersSubscriptionsResume(name: string, req: GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionRequest): Promise<GoogleCloudPaymentsResellerSubscriptionV1ResumeSubscriptionResponse>
[src]

Resumes a suspended subscription. The new billing cycle will start at the time of the request. It should be called directly by the partner using service accounts.

@param name

Required. The name of the subscription resource to be resumed. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}"

§
partnersSubscriptionsSuspend(name: string, req: GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionRequest): Promise<GoogleCloudPaymentsResellerSubscriptionV1SuspendSubscriptionResponse>
[src]

Suspends a subscription. Contract terms may dictate if a prorated refund will be issued upon suspension. It should be called directly by the partner using service accounts.

@param name

Required. The name of the subscription resource to be suspended. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}"

§
partnersSubscriptionsUndoCancel(name: string, req: GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest): Promise<GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionResponse>
[src]

Currently, it is used by Google One, Play Pass partners. Revokes the pending cancellation of a subscription, which is currently in STATE_CANCEL_AT_END_OF_CYCLE state. If the subscription is already cancelled, the request will fail. It should be called directly by the partner using service accounts.

@param name

Required. The name of the subscription resource whose pending cancellation needs to be undone. It will have the format of "partners/{partner_id}/subscriptions/{subscription_id}"

§
partnersUserSessionsGenerate(parent: string, req: GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionRequest): Promise<GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse>
[src]

This API replaces user authorized OAuth consent based APIs (Create, Entitle). Issues a timed session token for the given user intent. You can use the session token to redirect the user to Google to finish the signup flow. You can re-generate new session token repeatedly for the same request if necessary, regardless of the previous tokens being expired or not. By default, the session token is valid for 1 hour.

@param parent

Required. The parent, the partner that can resell. Format: partners/{partner}