paymentsresellersubscription

package
v0.200.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 9, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package paymentsresellersubscription provides access to the Payments Reseller Subscription API.

For product documentation, see: https://developers.google.com/payments/reseller/subscription/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/paymentsresellersubscription/v1"
...
ctx := context.Background()
paymentsresellersubscriptionService, err := paymentsresellersubscription.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

paymentsresellersubscriptionService, err := paymentsresellersubscription.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
paymentsresellersubscriptionService, err := paymentsresellersubscription.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// Associate you with your personal info on Google
	OpenIDScope = "openid"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type GoogleCloudPaymentsResellerSubscriptionV1Amount added in v0.97.0

type GoogleCloudPaymentsResellerSubscriptionV1Amount struct {
	// AmountMicros: Required. Amount in micros (1_000_000 micros = 1 currency
	// unit)
	AmountMicros int64 `json:"amountMicros,omitempty,string"`
	// CurrencyCode: Required. Currency codes in accordance with [ISO-4217 Currency
	// Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.
	CurrencyCode string `json:"currencyCode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AmountMicros") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AmountMicros") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1Amount: Describes the amount unit including the currency code.

func (GoogleCloudPaymentsResellerSubscriptionV1Amount) MarshalJSON added in v0.97.0

type GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest

type GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest struct {
	// CancelImmediately: Optional. If true, Google will cancel the subscription
	// immediately, and may or may not (based on the contract) issue a prorated
	// refund for the remainder of the billing cycle. Otherwise, Google defers the
	// cancelation at renewal_time, and will not issue a refund. - YouTube
	// subscriptions must use this option currently. However, the user will still
	// have access to the subscription until the end of the billing cycle.
	CancelImmediately bool `json:"cancelImmediately,omitempty"`
	// CancellationReason: Specifies the reason for the cancellation.
	//
	// Possible values:
	//   "CANCELLATION_REASON_UNSPECIFIED" - Reason is unspecified. Should not be
	// used.
	//   "CANCELLATION_REASON_FRAUD" - Fraudualant transaction.
	//   "CANCELLATION_REASON_REMORSE" - Buyer's remorse.
	//   "CANCELLATION_REASON_ACCIDENTAL_PURCHASE" - Accidential purchase.
	//   "CANCELLATION_REASON_PAST_DUE" - Payment is past due.
	//   "CANCELLATION_REASON_ACCOUNT_CLOSED" - Used for notification only, do not
	// use in Cancel API. User account closed.
	//   "CANCELLATION_REASON_UPGRADE_DOWNGRADE" - Used for notification only, do
	// not use in Cancel API. Cancellation due to upgrade or downgrade.
	//   "CANCELLATION_REASON_USER_DELINQUENCY" - Cancellation due to user
	// delinquency
	//   "CANCELLATION_REASON_SYSTEM_ERROR" - Used for notification only, do not
	// use in Cancel API. Cancellation due to an unrecoverable system error.
	//   "CANCELLATION_REASON_SYSTEM_CANCEL" - Used for notification only, do not
	// use in Cancel API. The subscription is cancelled by Google automatically
	// since it is no longer valid.
	//   "CANCELLATION_REASON_OTHER" - Other reason.
	CancellationReason string `json:"cancellationReason,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CancelImmediately") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CancelImmediately") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest: Request to cancel a subscription.

func (GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse

type GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse struct {
	// Subscription: The cancelled subscription resource.
	Subscription *GoogleCloudPaymentsResellerSubscriptionV1Subscription `json:"subscription,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Subscription") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Subscription") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse: Response that contains the cancelled subscription resource.

func (GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1Duration

type GoogleCloudPaymentsResellerSubscriptionV1Duration struct {
	// Count: number of duration units to be included.
	Count int64 `json:"count,omitempty"`
	// Unit: The unit used for the duration
	//
	// Possible values:
	//   "UNIT_UNSPECIFIED" - Default value, reserved as an invalid or an
	// unexpected value.
	//   "MONTH" - Unit of a calendar month.
	//   "DAY" - Unit of a day.
	//   "HOUR" - Unit of an hour. It is used for testing.
	Unit string `json:"unit,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Count") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Count") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1Duration: Describes the length of a period of a time.

func (GoogleCloudPaymentsResellerSubscriptionV1Duration) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest

type GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest struct {
	// LineItemEntitlementDetails: Optional. The line items to be entitled. If
	// unspecified, all line items will be entitled.
	LineItemEntitlementDetails []*GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequestLineItemEntitlementDetails `json:"lineItemEntitlementDetails,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LineItemEntitlementDetails")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LineItemEntitlementDetails") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest: LINT.IfChange Partner request for entitling the previously provisioned subscription to an end user. The end user identity is inferred from the request OAuth context.

func (GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest) MarshalJSON added in v0.144.0

type GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequestLineItemEntitlementDetails added in v0.144.0

type GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequestLineItemEntitlementDetails struct {
	// LineItemIndex: Required. The index of the line item to be entitled.
	LineItemIndex int64 `json:"lineItemIndex,omitempty"`
	// Products: Optional. Only applicable if the line item corresponds to a hard
	// bundle. Product resource names that identify the bundle elements to be
	// entitled in the line item. If unspecified, all bundle elements will be
	// entitled. The format is 'partners/{partner_id}/products/{product_id}'.
	Products []string `json:"products,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LineItemIndex") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LineItemIndex") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequestLineItemEn titlementDetails: The details of the line item to be entitled.

func (GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequestLineItemEntitlementDetails) MarshalJSON added in v0.144.0

type GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionResponse

type GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionResponse struct {
	// Subscription: The subscription that has user linked to it.
	Subscription *GoogleCloudPaymentsResellerSubscriptionV1Subscription `json:"subscription,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Subscription") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Subscription") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionResponse: Response that contains the entitled subscription resource.

func (GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionResponse) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest

type GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest struct {
	// Extension: Required. Specifies details of the extension. Currently, the
	// duration of the extension must be exactly one billing cycle of the original
	// subscription.
	Extension *GoogleCloudPaymentsResellerSubscriptionV1Extension `json:"extension,omitempty"`
	// RequestId: Required. Restricted to 36 ASCII characters. A random UUID is
	// recommended. The idempotency key for the request. The ID generation logic is
	// controlled by the partner. request_id should be the same as on retries of
	// the same request. A different request_id must be used for a extension of a
	// different cycle.
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Extension") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Extension") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest: Request message for extending a Subscription resource. A new recurrence will be made based on the subscription schedule defined by the original product.

func (GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionResponse

type GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionResponse struct {
	// CycleEndTime: The time at which the subscription is expected to be extended,
	// in ISO 8061 format. UTC timezone. Example,
	// "cycleEndTime":"2019-08-31T17:28:54.564Z"
	CycleEndTime string `json:"cycleEndTime,omitempty"`
	// FreeTrialEndTime: End of the free trial period, in ISO 8061 format. UTC
	// timezone. Example, "freeTrialEndTime":"2019-08-31T17:28:54.564Z" This time
	// will be set the same as initial subscription creation time if no free trial
	// period is offered to the partner.
	FreeTrialEndTime string `json:"freeTrialEndTime,omitempty"`
	// RenewalTime: Output only. The time at which the subscription is expected to
	// be renewed by Google - a new charge will be incurred and the service
	// entitlement will be renewed. A non-immediate cancellation will take place at
	// this time too, before which, the service entitlement for the end user will
	// remain valid. UTC timezone in ISO 8061 format. For example:
	// "2019-08-31T17:28:54.564Z"
	RenewalTime string `json:"renewalTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CycleEndTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CycleEndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionResponse: Response that contains the timestamps after the extension.

func (GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionResponse) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1Extension

type GoogleCloudPaymentsResellerSubscriptionV1Extension struct {
	// Duration: Required. Specifies the period of access the subscription should
	// grant.
	Duration *GoogleCloudPaymentsResellerSubscriptionV1Duration `json:"duration,omitempty"`
	// PartnerUserToken: Required. Identifier of the end-user in partner’s
	// system.
	PartnerUserToken string `json:"partnerUserToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Duration") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Duration") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1Extension: Describes the details of an extension request.

func (GoogleCloudPaymentsResellerSubscriptionV1Extension) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsRequest added in v0.78.0

type GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsRequest struct {
	// Filter: Optional. Specifies the filters for the promotion results. The
	// syntax is defined in https://google.aip.dev/160 with the following caveats:
	// 1. Only the following features are supported: - Logical operator `AND` -
	// Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has
	// operator `:` (no wildcards `*`) 2. Only the following fields are supported:
	// - `applicableProducts` - `regionCodes` -
	// `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3.
	// Unless explicitly mentioned above, other features are not supported.
	// Example: `applicableProducts:partners/partner1/products/product1 AND
	// regionCodes:US AND youtubePayload.postalCode=94043 AND
	// youtubePayload.partnerEligibilityId=eligibility-id`
	Filter string `json:"filter,omitempty"`
	// PageSize: Optional. The maximum number of promotions to return. The service
	// may return fewer than this value. If unspecified, at most 50 products will
	// be returned. The maximum value is 1000; values above 1000 will be coerced to
	// 1000.
	PageSize int64 `json:"pageSize,omitempty"`
	// PageToken: Optional. A page token, received from a previous `ListPromotions`
	// call. Provide this to retrieve the subsequent page. When paginating, all
	// other parameters provided to `ListPromotions` must match the call that
	// provided the page token.
	PageToken string `json:"pageToken,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Filter") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsRequest: Request to find eligible promotions for the current user.

func (GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsRequest) MarshalJSON added in v0.78.0

type GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsResponse added in v0.78.0

type GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is empty, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Promotions: The promotions for the current user.
	Promotions []*GoogleCloudPaymentsResellerSubscriptionV1Promotion `json:"promotions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsResponse: Response containing the found promotions for the current user.

func (GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsResponse) MarshalJSON added in v0.78.0

type GoogleCloudPaymentsResellerSubscriptionV1FiniteBillingCycleDetails added in v0.138.0

type GoogleCloudPaymentsResellerSubscriptionV1FiniteBillingCycleDetails struct {
	// BillingCycleCountLimit: Required. The number of a subscription line item
	// billing cycles after which billing will stop automatically.
	BillingCycleCountLimit int64 `json:"billingCycleCountLimit,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "BillingCycleCountLimit") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BillingCycleCountLimit") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1FiniteBillingCycleDetails: Details for a subscriptiin line item with finite billing cycles.

func (GoogleCloudPaymentsResellerSubscriptionV1FiniteBillingCycleDetails) MarshalJSON added in v0.138.0

type GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload added in v0.104.0

type GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload struct {
	// Campaigns: Campaign attributed to sales of this subscription.
	Campaigns []string `json:"campaigns,omitempty"`
	// Offering: The type of offering the subscription was sold by the partner.
	// e.g. VAS.
	//
	// Possible values:
	//   "OFFERING_UNSPECIFIED" - The type of partner offering is unspecified.
	//   "OFFERING_VAS_BUNDLE" - Google One product purchased as a Value added
	// service in addition to existing partner's products. Customer pays additional
	// amount for Google One product.
	//   "OFFERING_VAS_STANDALONE" - Google One product purchased by itself by
	// customer as a value add service. Customer pays additional amount for Google
	// One product.
	//   "OFFERING_HARD_BUNDLE" - Product purchased as part of a hard bundle where
	// Google One was included with the bundle. Google One pricing is included in
	// the bundle.
	//   "OFFERING_SOFT_BUNDLE" - Purchased as part of a bundle where Google One
	// was provided as an option. Google One pricing is included in the bundle.
	Offering string `json:"offering,omitempty"`
	// SalesChannel: The type of sales channel through which the subscription was
	// sold.
	//
	// Possible values:
	//   "CHANNEL_UNSPECIFIED" - The channel type is unspecified.
	//   "CHANNEL_RETAIL" - Sold at store.
	//   "CHANNEL_ONLINE_WEB" - Sold through partner website.
	//   "CHANNEL_ONLINE_ANDROID_APP" - Sold through partner android app.
	//   "CHANNEL_ONLINE_IOS_APP" - Sold through partner iOS app.
	SalesChannel string `json:"salesChannel,omitempty"`
	// StoreId: The identifier for the partner store where the subscription was
	// sold.
	StoreId string `json:"storeId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Campaigns") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Campaigns") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload: Payload specific to Google One products.

func (GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload) MarshalJSON added in v0.104.0

type GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse

type GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is empty, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Products: The products for the specified partner.
	Products []*GoogleCloudPaymentsResellerSubscriptionV1Product `json:"products,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse: Response that contains the products.

func (GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1ListPromotionsResponse

type GoogleCloudPaymentsResellerSubscriptionV1ListPromotionsResponse struct {
	// NextPageToken: A token, which can be sent as `page_token` to retrieve the
	// next page. If this field is empty, there are no subsequent pages.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Promotions: The promotions for the specified partner.
	Promotions []*GoogleCloudPaymentsResellerSubscriptionV1Promotion `json:"promotions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1ListPromotionsResponse: Response that contains the promotions.

func (GoogleCloudPaymentsResellerSubscriptionV1ListPromotionsResponse) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1Location

type GoogleCloudPaymentsResellerSubscriptionV1Location struct {
	// PostalCode: The postal code this location refers to. Ex. "94043"
	PostalCode string `json:"postalCode,omitempty"`
	// RegionCode: 2-letter ISO region code for current content region. Ex.
	// “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1
	RegionCode string `json:"regionCode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PostalCode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "PostalCode") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1Location: Describes a location of an end user.

func (GoogleCloudPaymentsResellerSubscriptionV1Location) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1Product

type GoogleCloudPaymentsResellerSubscriptionV1Product struct {
	// BundleDetails: Output only. Output Only. Specifies the details for a bundle
	// product.
	BundleDetails *ProductBundleDetails `json:"bundleDetails,omitempty"`
	// FiniteBillingCycleDetails: Optional. Details for a subscription line item
	// with finite billing cycles. If unset, the line item will be charged
	// indefinitely.
	FiniteBillingCycleDetails *GoogleCloudPaymentsResellerSubscriptionV1FiniteBillingCycleDetails `json:"finiteBillingCycleDetails,omitempty"`
	// Name: Identifier. Response only. Resource name of the product. It will have
	// the format of "partners/{partner_id}/products/{product_id}"
	Name string `json:"name,omitempty"`
	// PriceConfigs: Output only. Price configs for the product in the available
	// regions.
	PriceConfigs []*GoogleCloudPaymentsResellerSubscriptionV1ProductPriceConfig `json:"priceConfigs,omitempty"`
	// ProductType: Output only. Output Only. Specifies the type of the product.
	//
	// Possible values:
	//   "PRODUCT_TYPE_UNSPECIFIED" - Unspecified. It's reserved as an unexpected
	// value, should not be used.
	//   "PRODUCT_TYPE_SUBSCRIPTION" - The product is a subscription.
	//   "PRODUCT_TYPE_BUNDLE_SUBSCRIPTION" - The product is a bundled subscription
	// plan, which includes multiple subscription elements.
	ProductType string `json:"productType,omitempty"`
	// RegionCodes: Output only. 2-letter ISO region code where the product is
	// available in. Ex. "US" Please refers to:
	// https://en.wikipedia.org/wiki/ISO_3166-1
	RegionCodes []string `json:"regionCodes,omitempty"`
	// SubscriptionBillingCycleDuration: Output only. Specifies the length of the
	// billing cycle of the subscription.
	SubscriptionBillingCycleDuration *GoogleCloudPaymentsResellerSubscriptionV1Duration `json:"subscriptionBillingCycleDuration,omitempty"`
	// Titles: Output only. Localized human readable name of the product.
	Titles []*GoogleTypeLocalizedText `json:"titles,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BundleDetails") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BundleDetails") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1Product: A Product resource that defines a subscription service that can be resold.

func (GoogleCloudPaymentsResellerSubscriptionV1Product) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1ProductBundleDetailsBundleElement added in v0.142.0

type GoogleCloudPaymentsResellerSubscriptionV1ProductBundleDetailsBundleElement struct {
	// Product: Required. Output only. Product resource name that identifies the
	// bundle element. The format is 'partners/{partner_id}/products/{product_id}'.
	Product string `json:"product,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Product") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Product") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1ProductBundleDetailsBundleElement: The individual product that is included in the bundle.

func (GoogleCloudPaymentsResellerSubscriptionV1ProductBundleDetailsBundleElement) MarshalJSON added in v0.142.0

type GoogleCloudPaymentsResellerSubscriptionV1ProductPayload added in v0.104.0

type GoogleCloudPaymentsResellerSubscriptionV1ProductPayload struct {
	// GoogleOnePayload: Product-specific payloads. Payload specific to Google One
	// products.
	GoogleOnePayload *GoogleCloudPaymentsResellerSubscriptionV1GoogleOnePayload `json:"googleOnePayload,omitempty"`
	// YoutubePayload: Payload specific to Youtube products.
	YoutubePayload *GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload `json:"youtubePayload,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GoogleOnePayload") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GoogleOnePayload") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1ProductPayload: Specifies product specific payload.

func (GoogleCloudPaymentsResellerSubscriptionV1ProductPayload) MarshalJSON added in v0.104.0

type GoogleCloudPaymentsResellerSubscriptionV1ProductPriceConfig added in v0.97.0

type GoogleCloudPaymentsResellerSubscriptionV1ProductPriceConfig struct {
	// Amount: Output only. The price in the region.
	Amount *GoogleCloudPaymentsResellerSubscriptionV1Amount `json:"amount,omitempty"`
	// RegionCode: Output only. 2-letter ISO region code where the product is
	// available in. Ex. "US".
	RegionCode string `json:"regionCode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Amount") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Amount") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1ProductPriceConfig: Configs the prices in an available region.

func (GoogleCloudPaymentsResellerSubscriptionV1ProductPriceConfig) MarshalJSON added in v0.97.0

type GoogleCloudPaymentsResellerSubscriptionV1Promotion

type GoogleCloudPaymentsResellerSubscriptionV1Promotion struct {
	// ApplicableProducts: Output only. The product ids this promotion can be
	// applied to.
	ApplicableProducts []string `json:"applicableProducts,omitempty"`
	// EndTime: Optional. Specifies the end time (exclusive) of the period that the
	// promotion is available in. If unset, the promotion is available
	// indefinitely.
	EndTime string `json:"endTime,omitempty"`
	// FreeTrialDuration: Optional. Specifies the duration of the free trial of the
	// subscription when promotion_type is PROMOTION_TYPE_FREE_TRIAL
	FreeTrialDuration *GoogleCloudPaymentsResellerSubscriptionV1Duration `json:"freeTrialDuration,omitempty"`
	// IntroductoryPricingDetails: Optional. Specifies the introductory pricing
	// details when the promotion_type is PROMOTION_TYPE_INTRODUCTORY_PRICING.
	IntroductoryPricingDetails *GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetails `json:"introductoryPricingDetails,omitempty"`
	// Name: Identifier. Response only. Resource name of the subscription
	// promotion. It will have the format of
	// "partners/{partner_id}/promotion/{promotion_id}"
	Name string `json:"name,omitempty"`
	// PromotionType: Output only. Output Only. Specifies the type of the
	// promotion.
	//
	// Possible values:
	//   "PROMOTION_TYPE_UNSPECIFIED" - The promotion type is unspecified.
	//   "PROMOTION_TYPE_FREE_TRIAL" - The promotion is a free trial.
	//   "PROMOTION_TYPE_INTRODUCTORY_PRICING" - The promotion is a reduced
	// introductory pricing.
	PromotionType string `json:"promotionType,omitempty"`
	// RegionCodes: Output only. 2-letter ISO region code where the promotion is
	// available in. Ex. "US" Please refers to:
	// https://en.wikipedia.org/wiki/ISO_3166-1
	RegionCodes []string `json:"regionCodes,omitempty"`
	// StartTime: Optional. Specifies the start time (inclusive) of the period that
	// the promotion is available in.
	StartTime string `json:"startTime,omitempty"`
	// Titles: Output only. Localized human readable name of the promotion.
	Titles []*GoogleTypeLocalizedText `json:"titles,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApplicableProducts") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ApplicableProducts") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1Promotion: A Promotion resource that defines a promotion for a subscription that can be resold.

func (GoogleCloudPaymentsResellerSubscriptionV1Promotion) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetails added in v0.61.0

type GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetails struct {
	// IntroductoryPricingSpecs: Output only. Specifies the introductory pricing
	// periods.
	IntroductoryPricingSpecs []*GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetailsIntroductoryPricingSpec `json:"introductoryPricingSpecs,omitempty"`
	// ForceSendFields is a list of field names (e.g. "IntroductoryPricingSpecs")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "IntroductoryPricingSpecs") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetails:

The details of a introductory pricing promotion.

func (GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetails) MarshalJSON added in v0.61.0

type GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetailsIntroductoryPricingSpec added in v0.61.0

type GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetailsIntroductoryPricingSpec struct {
	// DiscountAmount: Output only. The discount amount. The value is positive.
	DiscountAmount *GoogleCloudPaymentsResellerSubscriptionV1Amount `json:"discountAmount,omitempty"`
	// DiscountRatioMicros: Output only. The discount percentage in micros. For
	// example, 50,000 represents 5%.
	DiscountRatioMicros int64 `json:"discountRatioMicros,omitempty,string"`
	// RecurrenceCount: Output only. Output Only. The duration of an introductory
	// offer in billing cycles.
	RecurrenceCount int64 `json:"recurrenceCount,omitempty"`
	// RegionCode: Output only. 2-letter ISO region code where the product is
	// available in. Ex. "US".
	RegionCode string `json:"regionCode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DiscountAmount") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DiscountAmount") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetailsI ntroductoryPricingSpec: The duration of an introductory pricing promotion.

func (GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetailsIntroductoryPricingSpec) MarshalJSON added in v0.61.0

type GoogleCloudPaymentsResellerSubscriptionV1ServicePeriod added in v0.87.0

type GoogleCloudPaymentsResellerSubscriptionV1ServicePeriod struct {
	// EndTime: Optional. The end time of the service period. Time is exclusive.
	EndTime string `json:"endTime,omitempty"`
	// StartTime: Required. The start time of the service period. Time is
	// inclusive.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1ServicePeriod: A description of what time period or moment in time the product or service is being delivered over.

func (GoogleCloudPaymentsResellerSubscriptionV1ServicePeriod) MarshalJSON added in v0.87.0

type GoogleCloudPaymentsResellerSubscriptionV1Subscription

type GoogleCloudPaymentsResellerSubscriptionV1Subscription struct {
	// CancellationDetails: Output only. Describes the details of a cancelled
	// subscription. Only applicable to subscription of state `STATE_CANCELLED`.
	CancellationDetails *GoogleCloudPaymentsResellerSubscriptionV1SubscriptionCancellationDetails `json:"cancellationDetails,omitempty"`
	// CreateTime: Output only. System generated timestamp when the subscription is
	// created. UTC timezone.
	CreateTime string `json:"createTime,omitempty"`
	// CycleEndTime: Output only. The time at which the subscription is expected to
	// be extended, in ISO 8061 format. UTC timezone. For example:
	// "2019-08-31T17:28:54.564Z"
	CycleEndTime string `json:"cycleEndTime,omitempty"`
	// EndUserEntitled: Output only. Indicates if the subscription is entitled to
	// the end user.
	EndUserEntitled bool `json:"endUserEntitled,omitempty"`
	// FreeTrialEndTime: Output only. End of the free trial period, in ISO 8061
	// format. For example, "2019-08-31T17:28:54.564Z". It will be set the same as
	// createTime if no free trial promotion is specified.
	FreeTrialEndTime string `json:"freeTrialEndTime,omitempty"`
	// LineItems: Required. The line items of the subscription.
	LineItems []*GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItem `json:"lineItems,omitempty"`
	// Name: Identifier. Resource name of the subscription. It will have the format
	// of "partners/{partner_id}/subscriptions/{subscription_id}". This is
	// available for authorizeAddon, but otherwise is response only.
	Name string `json:"name,omitempty"`
	// PartnerUserToken: Required. Identifier of the end-user in partner’s
	// system. The value is restricted to 63 ASCII characters at the maximum.
	PartnerUserToken string `json:"partnerUserToken,omitempty"`
	// ProcessingState: Output only. Describes the processing state of the
	// subscription. See more details at the lifecycle of a subscription
	// (/payments/reseller/subscription/reference/index/Receive.Notifications#paymen
	// ts-subscription-lifecycle).
	//
	// Possible values:
	//   "PROCESSING_STATE_UNSPECIFIED" - The processing state is unspecified.
	//   "PROCESSING_STATE_CANCELLING" - The subscription is being cancelled.
	//   "PROCESSING_STATE_RECURRING" - The subscription is recurring.
	ProcessingState string `json:"processingState,omitempty"`
	// Products: Optional. Deprecated: consider using `line_items` as the input.
	// Required. Resource name that identifies the purchased products. The format
	// will be 'partners/{partner_id}/products/{product_id}'.
	Products []string `json:"products,omitempty"`
	// PromotionSpecs: Optional. Subscription-level promotions. Only free trial is
	// supported on this level. It determines the first renewal time of the
	// subscription to be the end of the free trial period. Specify the promotion
	// resource name only when used as input.
	PromotionSpecs []*GoogleCloudPaymentsResellerSubscriptionV1SubscriptionPromotionSpec `json:"promotionSpecs,omitempty"`
	// Promotions: Optional. Deprecated: consider using the top-level
	// `promotion_specs` as the input. Optional. Resource name that identifies one
	// or more promotions that can be applied on the product. A typical promotion
	// for a subscription is Free trial. The format will be
	// 'partners/{partner_id}/promotions/{promotion_id}'.
	Promotions []string `json:"promotions,omitempty"`
	// PurchaseTime: Optional. The timestamp when the user transaction was made
	// with the Partner. Specify for the case of "bundle with choice", and it must
	// be before the provision_time (when the user makes a selection).
	PurchaseTime string `json:"purchaseTime,omitempty"`
	// RedirectUri: Output only. The place where partners should redirect the
	// end-user to after creation. This field might also be populated when creation
	// failed. However, Partners should always prepare a default URL to redirect
	// the user in case this field is empty.
	RedirectUri string `json:"redirectUri,omitempty"`
	// RenewalTime: Output only. The time at which the subscription is expected to
	// be renewed by Google - a new charge will be incurred and the service
	// entitlement will be renewed. A non-immediate cancellation will take place at
	// this time too, before which, the service entitlement for the end user will
	// remain valid. UTC timezone in ISO 8061 format. For example:
	// "2019-08-31T17:28:54.564Z"
	RenewalTime string `json:"renewalTime,omitempty"`
	// ServiceLocation: Required. The location that the service is provided as
	// indicated by the partner.
	ServiceLocation *GoogleCloudPaymentsResellerSubscriptionV1Location `json:"serviceLocation,omitempty"`
	// State: Output only. Describes the state of the subscription. See more
	// details at the lifecycle of a subscription
	// (/payments/reseller/subscription/reference/index/Receive.Notifications#paymen
	// ts-subscription-lifecycle).
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - The state is unspecified.
	//   "STATE_CREATED" - The subscription is created, a state before it is moved
	// to STATE_ACTIVE.
	//   "STATE_ACTIVE" - The subscription is active.
	//   "STATE_CANCELLED" - The subscription is cancelled. This is the final state
	// of the subscription, as it can no longer be modified or reactivated.
	//   "STATE_IN_GRACE_PERIOD" - The subscription is in grace period. It can
	// happen: 1) in manual extend mode, the subscription is not extended by the
	// partner at the end of current cycle. 2) for outbound authorization enabled
	// partners, a renewal purchase order is rejected.
	//   "STATE_CANCEL_AT_END_OF_CYCLE" - The subscription is waiting to be
	// cancelled by the next recurrence cycle.
	//   "STATE_SUSPENDED" - The subscription is suspended.
	State string `json:"state,omitempty"`
	// UpdateTime: Output only. System generated timestamp when the subscription is
	// most recently updated. UTC timezone.
	UpdateTime string `json:"updateTime,omitempty"`
	// UpgradeDowngradeDetails: Optional. Details about the previous subscription
	// that this new subscription upgrades/downgrades from. Only populated if this
	// subscription is an upgrade/downgrade from another subscription.
	UpgradeDowngradeDetails *GoogleCloudPaymentsResellerSubscriptionV1SubscriptionUpgradeDowngradeDetails `json:"upgradeDowngradeDetails,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CancellationDetails") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CancellationDetails") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1Subscription: A subscription serves as a central billing entity between an external partner and Google. The underlying Google services rely on the subscription state to grant or revoke the user's service entitlement. It's important to note that the subscription state may not always perfectly align with the user's service entitlement. For example, some Google services may continue providing access to the user until the current billing cycle ends, even if the subscription has been immediately canceled. However, other services may not do the same. To fully understand the specific details, please consult the relevant contract or product policy.

func (GoogleCloudPaymentsResellerSubscriptionV1Subscription) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionCancellationDetails

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionCancellationDetails struct {
	// Reason: Output only. The reason of the cancellation.
	//
	// Possible values:
	//   "CANCELLATION_REASON_UNSPECIFIED" - Reason is unspecified. Should not be
	// used.
	//   "CANCELLATION_REASON_FRAUD" - Fraudualant transaction.
	//   "CANCELLATION_REASON_REMORSE" - Buyer's remorse.
	//   "CANCELLATION_REASON_ACCIDENTAL_PURCHASE" - Accidential purchase.
	//   "CANCELLATION_REASON_PAST_DUE" - Payment is past due.
	//   "CANCELLATION_REASON_ACCOUNT_CLOSED" - Used for notification only, do not
	// use in Cancel API. User account closed.
	//   "CANCELLATION_REASON_UPGRADE_DOWNGRADE" - Used for notification only, do
	// not use in Cancel API. Cancellation due to upgrade or downgrade.
	//   "CANCELLATION_REASON_USER_DELINQUENCY" - Cancellation due to user
	// delinquency
	//   "CANCELLATION_REASON_SYSTEM_ERROR" - Used for notification only, do not
	// use in Cancel API. Cancellation due to an unrecoverable system error.
	//   "CANCELLATION_REASON_SYSTEM_CANCEL" - Used for notification only, do not
	// use in Cancel API. The subscription is cancelled by Google automatically
	// since it is no longer valid.
	//   "CANCELLATION_REASON_OTHER" - Other reason.
	Reason string `json:"reason,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Reason") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Reason") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1SubscriptionCancellationDetails: Describes the details of a cancelled or cancelling subscription.

func (GoogleCloudPaymentsResellerSubscriptionV1SubscriptionCancellationDetails) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItem added in v0.79.0

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItem struct {
	// Amount: Output only. The price of the product/service in this line item. The
	// amount could be the wholesale price, or it can include a cost of sale based
	// on the contract.
	Amount *GoogleCloudPaymentsResellerSubscriptionV1Amount `json:"amount,omitempty"`
	// BundleDetails: Output only. The bundle details for the line item. Only
	// populated if the line item corresponds to a hard bundle.
	BundleDetails *SubscriptionLineItemBundleDetails `json:"bundleDetails,omitempty"`
	// Description: Output only. Description of this line item.
	Description string `json:"description,omitempty"`
	// FiniteBillingCycleDetails: Optional. Details for a subscription line item
	// with finite billing cycles. If unset, the line item will be charged
	// indefinitely. Used only with LINE_ITEM_RECURRENCE_TYPE_PERIODIC.
	FiniteBillingCycleDetails *GoogleCloudPaymentsResellerSubscriptionV1FiniteBillingCycleDetails `json:"finiteBillingCycleDetails,omitempty"`
	// LineItemFreeTrialEndTime: Output only. The free trial end time will be
	// populated after the line item is successfully processed. End time of the
	// line item free trial period, in ISO 8061 format. For example,
	// "2019-08-31T17:28:54.564Z". It will be set the same as createTime if no free
	// trial promotion is specified.
	LineItemFreeTrialEndTime string `json:"lineItemFreeTrialEndTime,omitempty"`
	// LineItemIndex: Output only. A unique index of the subscription line item.
	LineItemIndex int64 `json:"lineItemIndex,omitempty"`
	// LineItemPromotionSpecs: Optional. The promotions applied on the line item.
	// It can be: - an introductory pricing promotion. - a free trial promotion.
	// This feature is not enabled. If used, the request will be rejected. When
	// used as input in Create or Provision API, specify its resource name only.
	LineItemPromotionSpecs []*GoogleCloudPaymentsResellerSubscriptionV1SubscriptionPromotionSpec `json:"lineItemPromotionSpecs,omitempty"`
	// OneTimeRecurrenceDetails: Output only. Details only set for a ONE_TIME
	// recurrence line item.
	OneTimeRecurrenceDetails *GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemOneTimeRecurrenceDetails `json:"oneTimeRecurrenceDetails,omitempty"`
	// Product: Required. Product resource name that identifies one the line item
	// The format is 'partners/{partner_id}/products/{product_id}'.
	Product string `json:"product,omitempty"`
	// ProductPayload: Optional. Product specific payload for this line item.
	ProductPayload *GoogleCloudPaymentsResellerSubscriptionV1ProductPayload `json:"productPayload,omitempty"`
	// RecurrenceType: Output only. The recurrence type of the line item.
	//
	// Possible values:
	//   "LINE_ITEM_RECURRENCE_TYPE_UNSPECIFIED" - The line item recurrence type is
	// unspecified.
	//   "LINE_ITEM_RECURRENCE_TYPE_PERIODIC" - The line item recurs periodically.
	//   "LINE_ITEM_RECURRENCE_TYPE_ONE_TIME" - The line item does not recur in the
	// future.
	RecurrenceType string `json:"recurrenceType,omitempty"`
	// State: Output only. The state of the line item.
	//
	// Possible values:
	//   "LINE_ITEM_STATE_UNSPECIFIED" - Unspecified state.
	//   "LINE_ITEM_STATE_ACTIVE" - The line item is in ACTIVE state. If the
	// subscription is cancelled or suspended, the line item will not be charged
	// even if the line item is active.
	//   "LINE_ITEM_STATE_INACTIVE" - The line item is in INACTIVE state.
	//   "LINE_ITEM_STATE_NEW" - The line item is new, and is not activated or
	// charged yet.
	//   "LINE_ITEM_STATE_ACTIVATING" - The line item is being activated in order
	// to be charged. If a free trial applies to the line item, the line item is
	// pending a prorated charge at the end of the free trial period, as indicated
	// by `line_item_free_trial_end_time`.
	//   "LINE_ITEM_STATE_DEACTIVATING" - The line item is being deactivated, and a
	// prorated refund in being processed.
	//   "LINE_ITEM_STATE_WAITING_TO_DEACTIVATE" - The line item is scheduled to be
	// deactivated at the end of the current cycle.
	//   "LINE_ITEM_STATE_OFF_CYCLE_CHARGING" - Line item is being charged
	// off-cycle.
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Amount") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Amount") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItem: Individual line item definition of a subscription.

func (GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItem) MarshalJSON added in v0.79.0

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemBundleDetailsBundleElementDetails added in v0.142.0

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemBundleDetailsBundleElementDetails struct {
	// Product: Output only. Product resource name that identifies the bundle
	// element. The format is 'partners/{partner_id}/products/{product_id}'.
	Product string `json:"product,omitempty"`
	// UserAccountLinkedTime: Output only. The time when this product is linked to
	// an end user.
	UserAccountLinkedTime string `json:"userAccountLinkedTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Product") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Product") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemBundleDetailsBun dleElementDetails: The details for an element in the hard bundle.

func (GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemBundleDetailsBundleElementDetails) MarshalJSON added in v0.142.0

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemOneTimeRecurrenceDetails added in v0.87.0

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemOneTimeRecurrenceDetails struct {
	// ServicePeriod: Output only. The service period of the ONE_TIME line item.
	ServicePeriod *GoogleCloudPaymentsResellerSubscriptionV1ServicePeriod `json:"servicePeriod,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ServicePeriod") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ServicePeriod") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemOneTimeRecurrenc eDetails: Details for a ONE_TIME recurrence line item.

func (GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemOneTimeRecurrenceDetails) MarshalJSON added in v0.87.0

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionPromotionSpec added in v0.79.0

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionPromotionSpec struct {
	// FreeTrialDuration: Output only. The duration of the free trial if the
	// promotion is of type FREE_TRIAL.
	FreeTrialDuration *GoogleCloudPaymentsResellerSubscriptionV1Duration `json:"freeTrialDuration,omitempty"`
	// IntroductoryPricingDetails: Output only. The details of the introductory
	// pricing spec if the promotion is of type INTRODUCTORY_PRICING.
	IntroductoryPricingDetails *GoogleCloudPaymentsResellerSubscriptionV1PromotionIntroductoryPricingDetails `json:"introductoryPricingDetails,omitempty"`
	// Promotion: Required. Promotion resource name that identifies a promotion.
	// The format is 'partners/{partner_id}/promotions/{promotion_id}'.
	Promotion string `json:"promotion,omitempty"`
	// Type: Output only. The type of the promotion for the spec.
	//
	// Possible values:
	//   "PROMOTION_TYPE_UNSPECIFIED" - The promotion type is unspecified.
	//   "PROMOTION_TYPE_FREE_TRIAL" - The promotion is a free trial.
	//   "PROMOTION_TYPE_INTRODUCTORY_PRICING" - The promotion is a reduced
	// introductory pricing.
	Type string `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FreeTrialDuration") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FreeTrialDuration") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1SubscriptionPromotionSpec: Describes the spec for one promotion.

func (GoogleCloudPaymentsResellerSubscriptionV1SubscriptionPromotionSpec) MarshalJSON added in v0.79.0

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionUpgradeDowngradeDetails added in v0.49.0

type GoogleCloudPaymentsResellerSubscriptionV1SubscriptionUpgradeDowngradeDetails struct {
	// BillingCycleSpec: Required. Specifies the billing cycle spec for the new
	// upgraded/downgraded subscription.
	//
	// Possible values:
	//   "BILLING_CYCLE_SPEC_UNSPECIFIED" - Billing cycle spec is not specified.
	//   "BILLING_CYCLE_SPEC_ALIGN_WITH_PREVIOUS_SUBSCRIPTION" - The billing cycle
	// of the new subscription aligns with the previous subscription it upgrades or
	// downgrades from.
	//   "BILLING_CYCLE_SPEC_START_IMMEDIATELY" - The billing cycle of the new
	// subscription starts immediately.
	BillingCycleSpec string `json:"billingCycleSpec,omitempty"`
	// PreviousSubscriptionId: Required. The previous subscription id to be
	// replaced. This is not the full resource name, use the subscription_id
	// segment only.
	PreviousSubscriptionId string `json:"previousSubscriptionId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BillingCycleSpec") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BillingCycleSpec") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1SubscriptionUpgradeDowngradeDetails:

Details about the previous subscription that this new subscription

upgrades/downgrades from.

func (GoogleCloudPaymentsResellerSubscriptionV1SubscriptionUpgradeDowngradeDetails) MarshalJSON added in v0.49.0

type GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest

type GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest struct {
}

GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest: Request to revoke a cancellation request.

type GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionResponse

type GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionResponse struct {
	// Subscription: The updated subscription resource.
	Subscription *GoogleCloudPaymentsResellerSubscriptionV1Subscription `json:"subscription,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Subscription") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Subscription") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionResponse: Response that contains the updated subscription resource.

func (GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionResponse) MarshalJSON

type GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload added in v0.104.0

type GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload struct {
	// AccessEndTime: Output only. The access expiration time for this line item.
	AccessEndTime string `json:"accessEndTime,omitempty"`
	// PartnerEligibilityIds: The list of eligibility_ids which are applicable for
	// the line item.
	PartnerEligibilityIds []string `json:"partnerEligibilityIds,omitempty"`
	// PartnerPlanType: Optional. Specifies the plan type offered to the end user
	// by the partner.
	//
	// Possible values:
	//   "PARTNER_PLAN_TYPE_UNSPECIFIED" - Unspecified. Should not use, reserved as
	// an invalid value.
	//   "PARTNER_PLAN_TYPE_STANDALONE" - This item is offered as a standalone
	// product to the user.
	//   "PARTNER_PLAN_TYPE_HARD_BUNDLE" - This item is bundled with another
	// partner offering, the item is provisioned at purchase time.
	//   "PARTNER_PLAN_TYPE_SOFT_BUNDLE" - This item is bundled with another
	// partner offering, the item is provisioned after puchase, when the user opts
	// in this Google service.
	PartnerPlanType string `json:"partnerPlanType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AccessEndTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AccessEndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload: Payload specific to Youtube products.

func (GoogleCloudPaymentsResellerSubscriptionV1YoutubePayload) MarshalJSON added in v0.104.0

type GoogleTypeLocalizedText

type GoogleTypeLocalizedText struct {
	// LanguageCode: The text's BCP-47 language code, such as "en-US" or "sr-Latn".
	// For more information, see
	// http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
	LanguageCode string `json:"languageCode,omitempty"`
	// Text: Localized string in the language corresponding to language_code below.
	Text string `json:"text,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LanguageCode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "LanguageCode") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleTypeLocalizedText: Localized variant of a text in a particular language.

func (GoogleTypeLocalizedText) MarshalJSON

func (s GoogleTypeLocalizedText) MarshalJSON() ([]byte, error)

type PartnersProductsListCall

type PartnersProductsListCall struct {
	// contains filtered or unexported fields
}

func (*PartnersProductsListCall) Context

Context sets the context to be used in this call's Do method.

func (*PartnersProductsListCall) Do

Do executes the "paymentsresellersubscription.partners.products.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse.ServerResponse .Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PartnersProductsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*PartnersProductsListCall) Filter added in v0.78.0

Filter sets the optional parameter "filter": Specifies the filters for the product results. The syntax is defined in https://google.aip.dev/160 with the following caveats: 1. Only the following features are supported: - Logical operator `AND` - Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has operator `:` (no wildcards `*`) 2. Only the following fields are supported: - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id`

func (*PartnersProductsListCall) Header

func (c *PartnersProductsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*PartnersProductsListCall) IfNoneMatch

func (c *PartnersProductsListCall) IfNoneMatch(entityTag string) *PartnersProductsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*PartnersProductsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of products to return. The service may return fewer than this value. If unspecified, at most 50 products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*PartnersProductsListCall) PageToken

func (c *PartnersProductsListCall) PageToken(pageToken string) *PartnersProductsListCall

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProducts` must match the call that provided the page token.

func (*PartnersProductsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type PartnersProductsService

type PartnersProductsService struct {
	// contains filtered or unexported fields
}

func NewPartnersProductsService

func NewPartnersProductsService(s *Service) *PartnersProductsService

func (*PartnersProductsService) List

List: To retrieve the products that can be resold by the partner. It should be autenticated with a service account. - This API doesn't apply to YouTube products currently.

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

type PartnersPromotionsFindEligibleCall added in v0.78.0

type PartnersPromotionsFindEligibleCall struct {
	// contains filtered or unexported fields
}

func (*PartnersPromotionsFindEligibleCall) Context added in v0.78.0

Context sets the context to be used in this call's Do method.

func (*PartnersPromotionsFindEligibleCall) Do added in v0.78.0

Do executes the "paymentsresellersubscription.partners.promotions.findEligible" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsResponse.Serv erResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PartnersPromotionsFindEligibleCall) Fields added in v0.78.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*PartnersPromotionsFindEligibleCall) Header added in v0.78.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*PartnersPromotionsFindEligibleCall) Pages added in v0.78.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type PartnersPromotionsListCall

type PartnersPromotionsListCall struct {
	// contains filtered or unexported fields
}

func (*PartnersPromotionsListCall) Context

Context sets the context to be used in this call's Do method.

func (*PartnersPromotionsListCall) Do

Do executes the "paymentsresellersubscription.partners.promotions.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPaymentsResellerSubscriptionV1ListPromotionsResponse.ServerRespon se.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PartnersPromotionsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*PartnersPromotionsListCall) Filter

Filter sets the optional parameter "filter": Specifies the filters for the promotion results. The syntax is defined in https://google.aip.dev/160 with the following caveats: 1. Only the following features are supported: - Logical operator `AND` - Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has operator `:` (no wildcards `*`) 2. Only the following fields are supported: - `applicableProducts` - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `applicableProducts:partners/partner1/products/product1 AND regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id`

func (*PartnersPromotionsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*PartnersPromotionsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*PartnersPromotionsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

func (*PartnersPromotionsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token, received from a previous `ListPromotions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotions` must match the call that provided the page token.

func (*PartnersPromotionsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type PartnersPromotionsService

type PartnersPromotionsService struct {
	// contains filtered or unexported fields
}

func NewPartnersPromotionsService

func NewPartnersPromotionsService(s *Service) *PartnersPromotionsService

func (*PartnersPromotionsService) FindEligible added in v0.78.0

func (r *PartnersPromotionsService) FindEligible(parent string, googlecloudpaymentsresellersubscriptionv1findeligiblepromotionsrequest *GoogleCloudPaymentsResellerSubscriptionV1FindEligiblePromotionsRequest) *PartnersPromotionsFindEligibleCall

FindEligible: To find 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.

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

func (*PartnersPromotionsService) List

List: Retrieves the promotions, such as free trial, that can be used by the partner. - This API doesn't apply to YouTube promotions currently. It should be autenticated with a service account.

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

type PartnersService

type PartnersService struct {
	Products *PartnersProductsService

	Promotions *PartnersPromotionsService

	Subscriptions *PartnersSubscriptionsService
	// contains filtered or unexported fields
}

func NewPartnersService

func NewPartnersService(s *Service) *PartnersService

type PartnersSubscriptionsCancelCall

type PartnersSubscriptionsCancelCall struct {
	// contains filtered or unexported fields
}

func (*PartnersSubscriptionsCancelCall) Context

Context sets the context to be used in this call's Do method.

func (*PartnersSubscriptionsCancelCall) Do

Do executes the "paymentsresellersubscription.partners.subscriptions.cancel" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionResponse.ServerRe sponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PartnersSubscriptionsCancelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*PartnersSubscriptionsCancelCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type PartnersSubscriptionsCreateCall

type PartnersSubscriptionsCreateCall struct {
	// contains filtered or unexported fields
}

func (*PartnersSubscriptionsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*PartnersSubscriptionsCreateCall) Do

Do executes the "paymentsresellersubscription.partners.subscriptions.create" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPaymentsResellerSubscriptionV1Subscription.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PartnersSubscriptionsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*PartnersSubscriptionsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*PartnersSubscriptionsCreateCall) SubscriptionId

func (c *PartnersSubscriptionsCreateCall) SubscriptionId(subscriptionId string) *PartnersSubscriptionsCreateCall

SubscriptionId sets the optional parameter "subscriptionId": Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one.

type PartnersSubscriptionsEntitleCall

type PartnersSubscriptionsEntitleCall struct {
	// contains filtered or unexported fields
}

func (*PartnersSubscriptionsEntitleCall) Context

Context sets the context to be used in this call's Do method.

func (*PartnersSubscriptionsEntitleCall) Do

Do executes the "paymentsresellersubscription.partners.subscriptions.entitle" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionResponse.ServerR esponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PartnersSubscriptionsEntitleCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*PartnersSubscriptionsEntitleCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type PartnersSubscriptionsExtendCall

type PartnersSubscriptionsExtendCall struct {
	// contains filtered or unexported fields
}

func (*PartnersSubscriptionsExtendCall) Context

Context sets the context to be used in this call's Do method.

func (*PartnersSubscriptionsExtendCall) Do

Do executes the "paymentsresellersubscription.partners.subscriptions.extend" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionResponse.ServerRe sponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PartnersSubscriptionsExtendCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*PartnersSubscriptionsExtendCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type PartnersSubscriptionsGetCall

type PartnersSubscriptionsGetCall struct {
	// contains filtered or unexported fields
}

func (*PartnersSubscriptionsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*PartnersSubscriptionsGetCall) Do

Do executes the "paymentsresellersubscription.partners.subscriptions.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPaymentsResellerSubscriptionV1Subscription.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PartnersSubscriptionsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*PartnersSubscriptionsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*PartnersSubscriptionsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type PartnersSubscriptionsProvisionCall

type PartnersSubscriptionsProvisionCall struct {
	// contains filtered or unexported fields
}

func (*PartnersSubscriptionsProvisionCall) Context

Context sets the context to be used in this call's Do method.

func (*PartnersSubscriptionsProvisionCall) Do

Do executes the "paymentsresellersubscription.partners.subscriptions.provision" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPaymentsResellerSubscriptionV1Subscription.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PartnersSubscriptionsProvisionCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*PartnersSubscriptionsProvisionCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*PartnersSubscriptionsProvisionCall) SubscriptionId

SubscriptionId sets the optional parameter "subscriptionId": Required. Identifies the subscription resource on the Partner side. The value is restricted to 63 ASCII characters at the maximum. If a subscription was previously created with the same subscription_id, we will directly return that one.

type PartnersSubscriptionsService

type PartnersSubscriptionsService struct {
	// contains filtered or unexported fields
}

func NewPartnersSubscriptionsService

func NewPartnersSubscriptionsService(s *Service) *PartnersSubscriptionsService

func (*PartnersSubscriptionsService) Cancel

func (r *PartnersSubscriptionsService) Cancel(name string, googlecloudpaymentsresellersubscriptionv1cancelsubscriptionrequest *GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest) *PartnersSubscriptionsCancelCall

Cancel: Used by partners to cancel 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.

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

func (*PartnersSubscriptionsService) Create

func (r *PartnersSubscriptionsService) Create(parentid string, googlecloudpaymentsresellersubscriptionv1subscription *GoogleCloudPaymentsResellerSubscriptionV1Subscription) *PartnersSubscriptionsCreateCall

Create: 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.

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

func (*PartnersSubscriptionsService) Entitle

func (r *PartnersSubscriptionsService) Entitle(name string, googlecloudpaymentsresellersubscriptionv1entitlesubscriptionrequest *GoogleCloudPaymentsResellerSubscriptionV1EntitleSubscriptionRequest) *PartnersSubscriptionsEntitleCall

Entitle: Used by partners to entitle 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.

  • name: 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}".

func (*PartnersSubscriptionsService) Extend

func (r *PartnersSubscriptionsService) Extend(name string, googlecloudpaymentsresellersubscriptionv1extendsubscriptionrequest *GoogleCloudPaymentsResellerSubscriptionV1ExtendSubscriptionRequest) *PartnersSubscriptionsExtendCall

Extend: [Opt-in only] Most partners should be on auto-extend by default. Used by partners to extend 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.

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

func (*PartnersSubscriptionsService) Get

Get: Used by partners to get a subscription by id. It should be called directly by the partner using service accounts.

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

func (*PartnersSubscriptionsService) Provision

func (r *PartnersSubscriptionsService) Provision(parentid string, googlecloudpaymentsresellersubscriptionv1subscription *GoogleCloudPaymentsResellerSubscriptionV1Subscription) *PartnersSubscriptionsProvisionCall

Provision: 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.

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

func (*PartnersSubscriptionsService) UndoCancel

func (r *PartnersSubscriptionsService) UndoCancel(name string, googlecloudpaymentsresellersubscriptionv1undocancelsubscriptionrequest *GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionRequest) *PartnersSubscriptionsUndoCancelCall

UndoCancel: 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. - **This API doesn't apply to YouTube subscriptions.** It should be called directly by the partner using service accounts.

  • name: 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}".

type PartnersSubscriptionsUndoCancelCall

type PartnersSubscriptionsUndoCancelCall struct {
	// contains filtered or unexported fields
}

func (*PartnersSubscriptionsUndoCancelCall) Context

Context sets the context to be used in this call's Do method.

func (*PartnersSubscriptionsUndoCancelCall) Do

Do executes the "paymentsresellersubscription.partners.subscriptions.undoCancel" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPaymentsResellerSubscriptionV1UndoCancelSubscriptionResponse.Serv erResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*PartnersSubscriptionsUndoCancelCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*PartnersSubscriptionsUndoCancelCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProductBundleDetails added in v0.142.0

type ProductBundleDetails struct {
	// BundleElements: The individual products that are included in the bundle.
	BundleElements []*GoogleCloudPaymentsResellerSubscriptionV1ProductBundleDetailsBundleElement `json:"bundleElements,omitempty"`
	// EntitlementMode: The entitlement mode of the bundle product.
	//
	// Possible values:
	//   "ENTITLEMENT_MODE_UNSPECIFIED" - Unspecified. It's reserved as an
	// unexpected value, should not be used.
	//   "ENTITLEMENT_MODE_FULL" - All the bundle elements must be fully activated
	// in a single request.
	//   "ENTITLEMENT_MODE_INCREMENTAL" - The bundle elements could be
	// incrementally activated.
	EntitlementMode string `json:"entitlementMode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BundleElements") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BundleElements") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ProductBundleDetails: Details for a bundle product.

func (ProductBundleDetails) MarshalJSON added in v0.142.0

func (s ProductBundleDetails) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Partners *PartnersService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SubscriptionLineItemBundleDetails added in v0.142.0

type SubscriptionLineItemBundleDetails struct {
	// BundleElementDetails: Output only. The details for each element in the hard
	// bundle.
	BundleElementDetails []*GoogleCloudPaymentsResellerSubscriptionV1SubscriptionLineItemBundleDetailsBundleElementDetails `json:"bundleElementDetails,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BundleElementDetails") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BundleElementDetails") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SubscriptionLineItemBundleDetails: The bundle details for a line item corresponding to a hard bundle.

func (SubscriptionLineItemBundleDetails) MarshalJSON added in v0.142.0

func (s SubscriptionLineItemBundleDetails) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL