type Address struct {// AddressLine1: A customer's physical address. An address can be composed of// one to three lines. The `addressline2` and `addressLine3` are optional.AddressLine1string `json:"addressLine1,omitempty"`// AddressLine2: Line 2 of the address.AddressLine2string `json:"addressLine2,omitempty"`// AddressLine3: Line 3 of the address.AddressLine3string `json:"addressLine3,omitempty"`// ContactName: The customer contact's name. This is required.ContactNamestring `json:"contactName,omitempty"`// CountryCode: For `countryCode` information, see the ISO 3166 country code// elements. Verify that country is approved for resale of Google products.// This property is required when creating a new customer.CountryCodestring `json:"countryCode,omitempty"`// Kind: Identifies the resource as a customer address. Value:// `customers#address`Kindstring `json:"kind,omitempty"`// Locality: An example of a `locality` value is the city of `San Francisco`.Localitystring `json:"locality,omitempty"`// OrganizationName: The company or company division name. This is required.OrganizationNamestring `json:"organizationName,omitempty"`// PostalCode: A `postalCode` example is a postal zip code such as `94043`.// This property is required when creating a new customer.PostalCodestring `json:"postalCode,omitempty"`// Region: An example of a `region` value is `CA` for the state of California.Regionstring `json:"region,omitempty"`// ForceSendFields is a list of field names (e.g. "AddressLine1") 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. "AddressLine1") 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:"-"`}

func (Address)MarshalJSON¶

func (sAddress) MarshalJSON() ([]byte,error)

type ChangePlanRequest struct {// DealCode: Google-issued code (100 char max) for discounted pricing on// subscription plans. Deal code must be included in `changePlan` request in// order to receive discounted rate. This property is optional. If a deal code// has already been added to a subscription, this property may be left empty// and the existing discounted rate will still apply (if not empty, only// provide the deal code that is already present on the subscription). If a// deal code has never been added to a subscription and this property is left// blank, regular pricing will apply.DealCodestring `json:"dealCode,omitempty"`// Kind: Identifies the resource as a subscription change plan request. Value:// `subscriptions#changePlanRequest`Kindstring `json:"kind,omitempty"`// PlanName: The `planName` property is required. This is the name of the// subscription's payment plan. For more information about the Google payment// plans, see API concepts. Possible values are: - `ANNUAL_MONTHLY_PAY` - The// annual commitment plan with monthly payments *Caution: *`ANNUAL_MONTHLY_PAY`// is returned as `ANNUAL` in all API responses. - `ANNUAL_YEARLY_PAY` - The// annual commitment plan with yearly payments - `FLEXIBLE` - The flexible plan// - `TRIAL` - The 30-day free trial planPlanNamestring `json:"planName,omitempty"`// PurchaseOrderId: This is an optional property. This purchase order (PO)// information is for resellers to use for their company tracking usage. If a// `purchaseOrderId` value is given it appears in the API responses and shows// up in the invoice. The property accepts up to 80 plain text characters.PurchaseOrderIdstring `json:"purchaseOrderId,omitempty"`// Seats: This is a required property. The seats property is the number of user// seat licenses.Seats *Seats `json:"seats,omitempty"`// ForceSendFields is a list of field names (e.g. "DealCode") 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. "DealCode") 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:"-"`}

func (ChangePlanRequest)MarshalJSON¶

func (sChangePlanRequest) MarshalJSON() ([]byte,error)

type Customer struct {// AlternateEmail: Like the "Customer email" in the reseller tools, this email// is the secondary contact used if something happens to the customer's service// such as service outage or a security issue. This property is required when// creating a new "domain" customer and should not use the same domain as// `customerDomain`. The `alternateEmail` field is not necessary to create a// "team" customer.AlternateEmailstring `json:"alternateEmail,omitempty"`// CustomerDomain: The customer's primary domain name string. `customerDomain`// is required when creating a new customer. Do not include the `www` prefix in// the domain when adding a customer.CustomerDomainstring `json:"customerDomain,omitempty"`// CustomerDomainVerified: Whether the customer's primary domain has been// verified.CustomerDomainVerifiedbool `json:"customerDomainVerified,omitempty"`// CustomerId: This property will always be returned in a response as the// unique identifier generated by Google. In a request, this property can be// either the primary domain or the unique identifier generated by Google.CustomerIdstring `json:"customerId,omitempty"`// CustomerType: Identifies the type of the customer. Acceptable values// include: * `domain`: Implies a domain-verified customer (default). * `team`:// Implies an email-verified customer. For more information, see managed teams// (https://support.google.com/a/users/answer/9939479).//// Possible values://   "customerTypeUnspecified" - Customer type not known//   "domain" - Domained or domain-owning customers//   "team" - Domainless or email-verified customersCustomerTypestring `json:"customerType,omitempty"`// Kind: Identifies the resource as a customer. Value: `reseller#customer`Kindstring `json:"kind,omitempty"`// PhoneNumber: Customer contact phone number. Must start with "+" followed by// the country code. The rest of the number can be contiguous numbers or// respect the phone local format conventions, but it must be a real phone// number and not, for example, "123". This field is silently ignored if// invalid.PhoneNumberstring `json:"phoneNumber,omitempty"`// PostalAddress: A customer's address information. Each field has a limit of// 255 charcters.PostalAddress *Address `json:"postalAddress,omitempty"`// PrimaryAdmin: The first admin details of the customer, present in case of// TEAM customer.PrimaryAdmin *PrimaryAdmin `json:"primaryAdmin,omitempty"`// ResourceUiUrl: URL to customer's Admin console dashboard. The read-only URL// is generated by the API service. This is used if your client application// requires the customer to complete a task in the Admin console.ResourceUiUrlstring `json:"resourceUiUrl,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "AlternateEmail") 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. "AlternateEmail") 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:"-"`}

func (Customer)MarshalJSON¶

func (sCustomer) MarshalJSON() ([]byte,error)

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

func (*CustomersGetCall)Context¶

func (c *CustomersGetCall) Context(ctxcontext.Context) *CustomersGetCall

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

func (*CustomersGetCall)Do¶

func (c *CustomersGetCall) Do(opts ...googleapi.CallOption) (*Customer,error)

Do executes the "reseller.customers.get" call.Any non-2xx status code is an error. Response headers are in either*Customer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersGetCall)Fields¶

func (c *CustomersGetCall) Fields(s ...googleapi.Field) *CustomersGetCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersGetCall)Header¶

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

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

func (*CustomersGetCall)IfNoneMatch¶

func (c *CustomersGetCall) IfNoneMatch(entityTagstring) *CustomersGetCall

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

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

func (*CustomersInsertCall)Context¶

func (c *CustomersInsertCall) Context(ctxcontext.Context) *CustomersInsertCall

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

func (*CustomersInsertCall)CustomerAuthToken¶

func (c *CustomersInsertCall) CustomerAuthToken(customerAuthTokenstring) *CustomersInsertCall

CustomerAuthToken sets the optional parameter "customerAuthToken": The`customerAuthToken` query string is required when creating a resold accountthat transfers a direct customer's subscription or transfers anotherreseller customer's subscription to your reseller management. This is ahexadecimal authentication token needed to complete the subscriptiontransfer. For more information, see the administrator help center.

func (*CustomersInsertCall)Do¶

func (c *CustomersInsertCall) Do(opts ...googleapi.CallOption) (*Customer,error)

Do executes the "reseller.customers.insert" call.Any non-2xx status code is an error. Response headers are in either*Customer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersInsertCall)Fields¶

func (c *CustomersInsertCall) Fields(s ...googleapi.Field) *CustomersInsertCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersInsertCall)Header¶

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

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

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

func (*CustomersPatchCall)Context¶

func (c *CustomersPatchCall) Context(ctxcontext.Context) *CustomersPatchCall

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

func (*CustomersPatchCall)Do¶

func (c *CustomersPatchCall) Do(opts ...googleapi.CallOption) (*Customer,error)

Do executes the "reseller.customers.patch" call.Any non-2xx status code is an error. Response headers are in either*Customer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersPatchCall)Fields¶

func (c *CustomersPatchCall) Fields(s ...googleapi.Field) *CustomersPatchCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersPatchCall)Header¶

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

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

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

funcNewCustomersService¶

func NewCustomersService(s *Service) *CustomersService

func (*CustomersService)Get¶

func (r *CustomersService) Get(customerIdstring) *CustomersGetCall

Get: Gets a customer account. Use this operation to see a customer accountalready in your reseller management, or to see the minimal accountinformation for an existing customer that you do not manage. For moreinformation about the API response for existing customers, see retrieving acustomer account(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#get_customer).

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.

func (*CustomersService)Insert¶

func (r *CustomersService) Insert(customer *Customer) *CustomersInsertCall

Insert: Orders a new customer's account. Before ordering a new customeraccount, establish whether the customer account already exists using the`customers.get`(https://developers.google.com/workspace/admin/reseller/v1/reference/customers/get)If the customer account exists as a direct Google account or as a resoldcustomer account from another reseller, use the `customerAuthToken\` asdescribed in order a resold account for an existing customer(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#create_existing_customer).For more information about ordering a new customer account, see order a newcustomer account(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#create_customer).After creating a new customer account, you must provision a user as anadministrator. The customer's administrator is required to sign in to theAdmin console and sign the G Suite via Reseller agreement to activate theaccount. Resellers are prohibited from signing the G Suite via Reselleragreement on the customer's behalf. For more information, see order a newcustomer account(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#tos).

func (*CustomersService)Patch¶

func (r *CustomersService) Patch(customerIdstring, customer *Customer) *CustomersPatchCall

Patch: Updates a customer account's settings. This method supports patchsemantics. You cannot update `customerType` via the Reseller API, but a"team" customer can verify their domain and become `customerType ="domain". For more information, see Verify your domain to unlock Essentialsfeatures (https://support.google.com/a/answer/9122284).

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.

func (*CustomersService)Update¶

func (r *CustomersService) Update(customerIdstring, customer *Customer) *CustomersUpdateCall

Update: Updates a customer account's settings. You cannot update`customerType` via the Reseller API, but a "team" customer can verifytheir domain and become `customerType = "domain". For more information, seeupdate a customer's settings(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_customers#update_customer).

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.

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

func (*CustomersUpdateCall)Context¶

func (c *CustomersUpdateCall) Context(ctxcontext.Context) *CustomersUpdateCall

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

func (*CustomersUpdateCall)Do¶

func (c *CustomersUpdateCall) Do(opts ...googleapi.CallOption) (*Customer,error)

Do executes the "reseller.customers.update" call.Any non-2xx status code is an error. Response headers are in either*Customer.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*CustomersUpdateCall)Fields¶

func (c *CustomersUpdateCall) Fields(s ...googleapi.Field) *CustomersUpdateCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CustomersUpdateCall)Header¶

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

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

type PrimaryAdmin struct {// PrimaryEmail: The business email of the primary administrator of the// customer. The email verification link is sent to this email address at the// time of customer creation. Primary administrators have access to the// customer's Admin Console, including the ability to invite and evict users// and manage the administrative needs of the customer.PrimaryEmailstring `json:"primaryEmail,omitempty"`// ForceSendFields is a list of field names (e.g. "PrimaryEmail") 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. "PrimaryEmail") 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:"-"`}

func (PrimaryAdmin)MarshalJSON¶added inv0.50.0

func (sPrimaryAdmin) MarshalJSON() ([]byte,error)

type RenewalSettings struct {// Kind: Identifies the resource as a subscription renewal setting. Value:// `subscriptions#renewalSettings`Kindstring `json:"kind,omitempty"`// RenewalType: Renewal settings for the annual commitment plan. For more// detailed information, see renewal options in the administrator help center.// When renewing a subscription, the `renewalType` is a required property.RenewalTypestring `json:"renewalType,omitempty"`// ForceSendFields is a list of field names (e.g. "Kind") 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. "Kind") 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:"-"`}

func (RenewalSettings)MarshalJSON¶

func (sRenewalSettings) MarshalJSON() ([]byte,error)

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

func (*ResellernotifyGetwatchdetailsCall)Context¶

func (c *ResellernotifyGetwatchdetailsCall) Context(ctxcontext.Context) *ResellernotifyGetwatchdetailsCall

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

func (*ResellernotifyGetwatchdetailsCall)Do¶

func (c *ResellernotifyGetwatchdetailsCall) Do(opts ...googleapi.CallOption) (*ResellernotifyGetwatchdetailsResponse,error)

Do executes the "reseller.resellernotify.getwatchdetails" call.Any non-2xx status code is an error. Response headers are in either*ResellernotifyGetwatchdetailsResponse.ServerResponse.Header or (if aresponse was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ResellernotifyGetwatchdetailsCall)Fields¶

func (c *ResellernotifyGetwatchdetailsCall) Fields(s ...googleapi.Field) *ResellernotifyGetwatchdetailsCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResellernotifyGetwatchdetailsCall)Header¶

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

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

func (*ResellernotifyGetwatchdetailsCall)IfNoneMatch¶

func (c *ResellernotifyGetwatchdetailsCall) IfNoneMatch(entityTagstring) *ResellernotifyGetwatchdetailsCall

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

type ResellernotifyGetwatchdetailsResponse struct {// ServiceAccountEmailAddresses: List of registered service accounts.ServiceAccountEmailAddresses []string `json:"serviceAccountEmailAddresses,omitempty"`// TopicName: Topic name of the PubSubTopicNamestring `json:"topicName,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g.// "ServiceAccountEmailAddresses") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ServiceAccountEmailAddresses") 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:"-"`}

func (ResellernotifyGetwatchdetailsResponse)MarshalJSON¶

func (sResellernotifyGetwatchdetailsResponse) MarshalJSON() ([]byte,error)

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

func (*ResellernotifyRegisterCall)Context¶

func (c *ResellernotifyRegisterCall) Context(ctxcontext.Context) *ResellernotifyRegisterCall

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

func (*ResellernotifyRegisterCall)Do¶

func (c *ResellernotifyRegisterCall) Do(opts ...googleapi.CallOption) (*ResellernotifyResource,error)

Do executes the "reseller.resellernotify.register" call.Any non-2xx status code is an error. Response headers are in either*ResellernotifyResource.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ResellernotifyRegisterCall)Fields¶

func (c *ResellernotifyRegisterCall) Fields(s ...googleapi.Field) *ResellernotifyRegisterCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResellernotifyRegisterCall)Header¶

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

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

func (*ResellernotifyRegisterCall)ServiceAccountEmailAddress¶

func (c *ResellernotifyRegisterCall) ServiceAccountEmailAddress(serviceAccountEmailAddressstring) *ResellernotifyRegisterCall

ServiceAccountEmailAddress sets the optional parameter"serviceAccountEmailAddress": The service account which will own the createdCloud-PubSub topic.

type ResellernotifyResource struct {// TopicName: Topic name of the PubSubTopicNamestring `json:"topicName,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "TopicName") 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. "TopicName") 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:"-"`}

func (ResellernotifyResource)MarshalJSON¶

func (sResellernotifyResource) MarshalJSON() ([]byte,error)

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

funcNewResellernotifyService¶

func NewResellernotifyService(s *Service) *ResellernotifyService

func (*ResellernotifyService)Getwatchdetails¶

func (r *ResellernotifyService) Getwatchdetails() *ResellernotifyGetwatchdetailsCall

Getwatchdetails: Returns all the details of the watch corresponding to thereseller.

func (*ResellernotifyService)Register¶

func (r *ResellernotifyService) Register() *ResellernotifyRegisterCall

Register: Registers a Reseller for receiving notifications.

func (*ResellernotifyService)Unregister¶

func (r *ResellernotifyService) Unregister() *ResellernotifyUnregisterCall

Unregister: Unregisters a Reseller for receiving notifications.

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

func (*ResellernotifyUnregisterCall)Context¶

func (c *ResellernotifyUnregisterCall) Context(ctxcontext.Context) *ResellernotifyUnregisterCall

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

func (*ResellernotifyUnregisterCall)Do¶

func (c *ResellernotifyUnregisterCall) Do(opts ...googleapi.CallOption) (*ResellernotifyResource,error)

Do executes the "reseller.resellernotify.unregister" call.Any non-2xx status code is an error. Response headers are in either*ResellernotifyResource.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ResellernotifyUnregisterCall)Fields¶

func (c *ResellernotifyUnregisterCall) Fields(s ...googleapi.Field) *ResellernotifyUnregisterCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ResellernotifyUnregisterCall)Header¶

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

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

func (*ResellernotifyUnregisterCall)ServiceAccountEmailAddress¶

func (c *ResellernotifyUnregisterCall) ServiceAccountEmailAddress(serviceAccountEmailAddressstring) *ResellernotifyUnregisterCall

ServiceAccountEmailAddress sets the optional parameter"serviceAccountEmailAddress": The service account which owns theCloud-PubSub topic.

type Seats struct {// Kind: Identifies the resource as a subscription seat setting. Value:// `subscriptions#seats`Kindstring `json:"kind,omitempty"`// LicensedNumberOfSeats: Read-only field containing the current number of// users that are assigned a license for the product defined in `skuId`. This// field's value is equivalent to the numerical count of users returned by the// Enterprise License Manager API method: `listForProductAndSku`// (https://developers.google.com/workspace/admin/licensing/v1/reference/licenseAssignments/listForProductAndSku).LicensedNumberOfSeatsint64 `json:"licensedNumberOfSeats,omitempty"`// MaximumNumberOfSeats: This is a required property and is exclusive to// subscriptions with `FLEXIBLE` or `TRIAL` plans. This property sets the// maximum number of licensed users allowed on a subscription. This quantity// can be increased up to the maximum limit defined in the reseller's contract.// The minimum quantity is the current number of users in the customer account.// *Note: *G Suite subscriptions automatically assign a license to every user.MaximumNumberOfSeatsint64 `json:"maximumNumberOfSeats,omitempty"`// NumberOfSeats: This is a required property and is exclusive to subscriptions// with `ANNUAL_MONTHLY_PAY` and `ANNUAL_YEARLY_PAY` plans. This property sets// the maximum number of licenses assignable to users on a subscription. The// reseller can add more licenses, but once set, the `numberOfSeats` cannot be// reduced until renewal. The reseller is invoiced based on the `numberOfSeats`// value regardless of how many of these user licenses are assigned. *Note:// *Google Workspace subscriptions automatically assign a license to every// user.NumberOfSeatsint64 `json:"numberOfSeats,omitempty"`// ForceSendFields is a list of field names (e.g. "Kind") 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. "Kind") 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:"-"`}

func (Seats)MarshalJSON¶

func (sSeats) MarshalJSON() ([]byte,error)

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentCustomers *CustomersServiceResellernotify *ResellernotifyServiceSubscriptions *SubscriptionsService// contains filtered or unexported fields}

funcNewService¶added inv0.3.0

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

NewService creates a new Service.

type Subscription struct {// BillingMethod: Read-only field that returns the current billing method for a// subscription.BillingMethodstring `json:"billingMethod,omitempty"`// CreationTime: The `creationTime` property is the date when subscription was// created. It is in milliseconds using the Epoch format. See an example Epoch// converter.CreationTimeint64 `json:"creationTime,omitempty,string"`// CustomerDomain: Primary domain name of the customerCustomerDomainstring `json:"customerDomain,omitempty"`// CustomerId: This property will always be returned in a response as the// unique identifier generated by Google. In a request, this property can be// either the primary domain or the unique identifier generated by Google.CustomerIdstring `json:"customerId,omitempty"`// DealCode: Google-issued code (100 char max) for discounted pricing on// subscription plans. Deal code must be included in `insert` requests in order// to receive discounted rate. This property is optional, regular pricing// applies if left empty.DealCodestring `json:"dealCode,omitempty"`// Kind: Identifies the resource as a Subscription. Value:// `reseller#subscription`Kindstring `json:"kind,omitempty"`// Plan: The `plan` property is required. In this version of the API, the G// Suite plans are the flexible plan, annual commitment plan, and the 30-day// free trial plan. For more information about the API"s payment plans, see the// API concepts.Plan *SubscriptionPlan `json:"plan,omitempty"`// PurchaseOrderId: This is an optional property. This purchase order (PO)// information is for resellers to use for their company tracking usage. If a// `purchaseOrderId` value is given it appears in the API responses and shows// up in the invoice. The property accepts up to 80 plain text characters.PurchaseOrderIdstring `json:"purchaseOrderId,omitempty"`// RenewalSettings: Renewal settings for the annual commitment plan. For more// detailed information, see renewal options in the administrator help center.RenewalSettings *RenewalSettings `json:"renewalSettings,omitempty"`// ResourceUiUrl: URL to customer's Subscriptions page in the Admin console.// The read-only URL is generated by the API service. This is used if your// client application requires the customer to complete a task using the// Subscriptions page in the Admin console.ResourceUiUrlstring `json:"resourceUiUrl,omitempty"`// Seats: This is a required property. The number and limit of user seat// licenses in the plan.Seats *Seats `json:"seats,omitempty"`// SkuId: A required property. The `skuId` is a unique system identifier for a// product's SKU assigned to a customer in the subscription. For products and// SKUs available in this version of the API, see Product and SKU IDs.SkuIdstring `json:"skuId,omitempty"`// SkuName: Read-only external display name for a product's SKU assigned to a// customer in the subscription. SKU names are subject to change at Google's// discretion. For products and SKUs available in this version of the API, see// Product and SKU IDs.SkuNamestring `json:"skuName,omitempty"`// Status: This is an optional property.Statusstring `json:"status,omitempty"`// SubscriptionId: The `subscriptionId` is the subscription identifier and is// unique for each customer. This is a required property. Since a// `subscriptionId` changes when a subscription is updated, we recommend not// using this ID as a key for persistent data. Use the `subscriptionId` as// described in retrieve all reseller subscriptions.SubscriptionIdstring `json:"subscriptionId,omitempty"`// SuspensionReasons: Read-only field containing an enumerable of all the// current suspension reasons for a subscription. It is possible for a// subscription to have many concurrent, overlapping suspension reasons. A// subscription's `STATUS` is `SUSPENDED` until all pending suspensions are// removed. Possible options include: - `PENDING_TOS_ACCEPTANCE` - The customer// has not logged in and accepted the G Suite Resold Terms of Services. -// `RENEWAL_WITH_TYPE_CANCEL` - The customer's commitment ended and their// service was cancelled at the end of their term. - `RESELLER_INITIATED` - A// manual suspension invoked by a Reseller. - `TRIAL_ENDED` - The customer's// trial expired without a plan selected. - `OTHER` - The customer is suspended// for an internal Google reason (e.g. abuse or otherwise).SuspensionReasons []string `json:"suspensionReasons,omitempty"`// TransferInfo: Read-only transfer related information for the subscription.// For more information, see retrieve transferable subscriptions for a// customer.TransferInfo *SubscriptionTransferInfo `json:"transferInfo,omitempty"`// TrialSettings: The G Suite annual commitment and flexible payment plans can// be in a 30-day free trial. For more information, see the API concepts.TrialSettings *SubscriptionTrialSettings `json:"trialSettings,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "BillingMethod") 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. "BillingMethod") 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:"-"`}

func (Subscription)MarshalJSON¶

func (sSubscription) MarshalJSON() ([]byte,error)

type SubscriptionPlan struct {// CommitmentInterval: In this version of the API, annual commitment plan's// interval is one year. *Note: *When `billingMethod` value is `OFFLINE`, the// subscription property object `plan.commitmentInterval` is omitted in all API// responses.CommitmentInterval *SubscriptionPlanCommitmentInterval `json:"commitmentInterval,omitempty"`// IsCommitmentPlan: The `isCommitmentPlan` property's boolean value identifies// the plan as an annual commitment plan: - `true` — The subscription's plan// is an annual commitment plan. - `false` — The plan is not an annual// commitment plan.IsCommitmentPlanbool `json:"isCommitmentPlan,omitempty"`// PlanName: The `planName` property is required. This is the name of the// subscription's plan. For more information about the Google payment plans,// see the API concepts. Possible values are: - `ANNUAL_MONTHLY_PAY` — The// annual commitment plan with monthly payments. *Caution:// *`ANNUAL_MONTHLY_PAY` is returned as `ANNUAL` in all API responses. -// `ANNUAL_YEARLY_PAY` — The annual commitment plan with yearly payments -// `FLEXIBLE` — The flexible plan - `TRIAL` — The 30-day free trial plan. A// subscription in trial will be suspended after the 30th free day if no// payment plan is assigned. Calling `changePlan` will assign a payment plan to// a trial but will not activate the plan. A trial will automatically begin its// assigned payment plan after its 30th free day or immediately after calling// `startPaidService`. - `FREE` — The free plan is exclusive to the Cloud// Identity SKU and does not incur any billing.PlanNamestring `json:"planName,omitempty"`// ForceSendFields is a list of field names (e.g. "CommitmentInterval") 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. "CommitmentInterval") 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:"-"`}

func (SubscriptionPlan)MarshalJSON¶

func (sSubscriptionPlan) MarshalJSON() ([]byte,error)

type SubscriptionPlanCommitmentInterval struct {// EndTime: An annual commitment plan's interval's `endTime` in milliseconds// using the UNIX Epoch format. See an example Epoch converter.EndTimeint64 `json:"endTime,omitempty,string"`// StartTime: An annual commitment plan's interval's `startTime` in// milliseconds using UNIX Epoch format. See an example Epoch converter.StartTimeint64 `json:"startTime,omitempty,string"`// 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:"-"`}

func (SubscriptionPlanCommitmentInterval)MarshalJSON¶

func (sSubscriptionPlanCommitmentInterval) MarshalJSON() ([]byte,error)

type SubscriptionTransferInfo struct {// CurrentLegacySkuId: The `skuId` of the current resold subscription. This is// populated only when the customer has a subscription with a legacy SKU and// the subscription resource is populated with the `skuId` of the SKU// recommended for the transfer.CurrentLegacySkuIdstring `json:"currentLegacySkuId,omitempty"`// MinimumTransferableSeats: When inserting a subscription, this is the minimum// number of seats listed in the transfer order for this product. For example,// if the customer has 20 users, the reseller cannot place a transfer order of// 15 seats. The minimum is 20 seats.MinimumTransferableSeatsint64 `json:"minimumTransferableSeats,omitempty"`// TransferabilityExpirationTime: The time when transfer token or intent to// transfer will expire. The time is in milliseconds using UNIX Epoch format.TransferabilityExpirationTimeint64 `json:"transferabilityExpirationTime,omitempty,string"`// ForceSendFields is a list of field names (e.g. "CurrentLegacySkuId") 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. "CurrentLegacySkuId") 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:"-"`}

func (SubscriptionTransferInfo)MarshalJSON¶

func (sSubscriptionTransferInfo) MarshalJSON() ([]byte,error)

type SubscriptionTrialSettings struct {// IsInTrial: Determines if a subscription's plan is in a 30-day free trial or// not: - `true` — The plan is in trial. - `false` — The plan is not in// trial.IsInTrialbool `json:"isInTrial,omitempty"`// TrialEndTime: Date when the trial ends. The value is in milliseconds using// the UNIX Epoch format. See an example Epoch converter.TrialEndTimeint64 `json:"trialEndTime,omitempty,string"`// ForceSendFields is a list of field names (e.g. "IsInTrial") 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. "IsInTrial") 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:"-"`}

func (SubscriptionTrialSettings)MarshalJSON¶

func (sSubscriptionTrialSettings) MarshalJSON() ([]byte,error)

type Subscriptions struct {// Kind: Identifies the resource as a collection of subscriptions. Value:// reseller#subscriptionsKindstring `json:"kind,omitempty"`// NextPageToken: The continuation token, used to page through large result// sets. Provide this value in a subsequent request to return the next page of// results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Subscriptions: The subscriptions in this page of results.Subscriptions []*Subscription `json:"subscriptions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Kind") 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. "Kind") 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:"-"`}

func (Subscriptions)MarshalJSON¶

func (sSubscriptions) MarshalJSON() ([]byte,error)

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

func (*SubscriptionsActivateCall)Context¶

func (c *SubscriptionsActivateCall) Context(ctxcontext.Context) *SubscriptionsActivateCall

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

func (*SubscriptionsActivateCall)Do¶

func (c *SubscriptionsActivateCall) Do(opts ...googleapi.CallOption) (*Subscription,error)

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

func (*SubscriptionsActivateCall)Fields¶

func (c *SubscriptionsActivateCall) Fields(s ...googleapi.Field) *SubscriptionsActivateCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SubscriptionsActivateCall)Header¶

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

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

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

func (*SubscriptionsChangePlanCall)Context¶

func (c *SubscriptionsChangePlanCall) Context(ctxcontext.Context) *SubscriptionsChangePlanCall

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

func (*SubscriptionsChangePlanCall)Do¶

func (c *SubscriptionsChangePlanCall) Do(opts ...googleapi.CallOption) (*Subscription,error)

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

func (*SubscriptionsChangePlanCall)Fields¶

func (c *SubscriptionsChangePlanCall) Fields(s ...googleapi.Field) *SubscriptionsChangePlanCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SubscriptionsChangePlanCall)Header¶

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

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

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

func (*SubscriptionsChangeRenewalSettingsCall)Context¶

func (c *SubscriptionsChangeRenewalSettingsCall) Context(ctxcontext.Context) *SubscriptionsChangeRenewalSettingsCall

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

func (*SubscriptionsChangeRenewalSettingsCall)Do¶

func (c *SubscriptionsChangeRenewalSettingsCall) Do(opts ...googleapi.CallOption) (*Subscription,error)

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

func (*SubscriptionsChangeRenewalSettingsCall)Fields¶

func (c *SubscriptionsChangeRenewalSettingsCall) Fields(s ...googleapi.Field) *SubscriptionsChangeRenewalSettingsCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SubscriptionsChangeRenewalSettingsCall)Header¶

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

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

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

func (*SubscriptionsChangeSeatsCall)Context¶

func (c *SubscriptionsChangeSeatsCall) Context(ctxcontext.Context) *SubscriptionsChangeSeatsCall

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

func (*SubscriptionsChangeSeatsCall)Do¶

func (c *SubscriptionsChangeSeatsCall) Do(opts ...googleapi.CallOption) (*Subscription,error)

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

func (*SubscriptionsChangeSeatsCall)Fields¶

func (c *SubscriptionsChangeSeatsCall) Fields(s ...googleapi.Field) *SubscriptionsChangeSeatsCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SubscriptionsChangeSeatsCall)Header¶

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

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

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

func (*SubscriptionsDeleteCall)Context¶

func (c *SubscriptionsDeleteCall) Context(ctxcontext.Context) *SubscriptionsDeleteCall

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

func (*SubscriptionsDeleteCall)Do¶

func (c *SubscriptionsDeleteCall) Do(opts ...googleapi.CallOption)error

Do executes the "reseller.subscriptions.delete" call.

func (*SubscriptionsDeleteCall)Fields¶

func (c *SubscriptionsDeleteCall) Fields(s ...googleapi.Field) *SubscriptionsDeleteCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SubscriptionsDeleteCall)Header¶

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

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

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

func (*SubscriptionsGetCall)Context¶

func (c *SubscriptionsGetCall) Context(ctxcontext.Context) *SubscriptionsGetCall

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

func (*SubscriptionsGetCall)Do¶

func (c *SubscriptionsGetCall) Do(opts ...googleapi.CallOption) (*Subscription,error)

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

func (*SubscriptionsGetCall)Fields¶

func (c *SubscriptionsGetCall) Fields(s ...googleapi.Field) *SubscriptionsGetCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SubscriptionsGetCall)Header¶

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

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

func (*SubscriptionsGetCall)IfNoneMatch¶

func (c *SubscriptionsGetCall) IfNoneMatch(entityTagstring) *SubscriptionsGetCall

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

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

func (*SubscriptionsInsertCall)Action¶added inv0.128.0

func (c *SubscriptionsInsertCall) Action(actionstring) *SubscriptionsInsertCall

Action sets the optional parameter "action": The intented insert action.Advised to set this when the customer already has a subscription for adifferent SKU in the same product.

Possible values:

"actionUnspecified" - Auto determines whether to create new subscription,

upgrade or downagrade existing subscription or transfer the existingsubscription

"buy" - Create new subscription"switch" - Switch existing subscription to another sku (upgrade/downgrade)

func (*SubscriptionsInsertCall)Context¶

func (c *SubscriptionsInsertCall) Context(ctxcontext.Context) *SubscriptionsInsertCall

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

func (*SubscriptionsInsertCall)CustomerAuthToken¶

func (c *SubscriptionsInsertCall) CustomerAuthToken(customerAuthTokenstring) *SubscriptionsInsertCall

CustomerAuthToken sets the optional parameter "customerAuthToken": The`customerAuthToken` query string is required when creating a resold accountthat transfers a direct customer's subscription or transfers anotherreseller customer's subscription to your reseller management. This is ahexadecimal authentication token needed to complete the subscriptiontransfer. For more information, see the administrator help center.

func (*SubscriptionsInsertCall)Do¶

func (c *SubscriptionsInsertCall) Do(opts ...googleapi.CallOption) (*Subscription,error)

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

func (*SubscriptionsInsertCall)Fields¶

func (c *SubscriptionsInsertCall) Fields(s ...googleapi.Field) *SubscriptionsInsertCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SubscriptionsInsertCall)Header¶

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

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

func (*SubscriptionsInsertCall)SourceSkuId¶added inv0.128.0

func (c *SubscriptionsInsertCall) SourceSkuId(sourceSkuIdstring) *SubscriptionsInsertCall

SourceSkuId sets the optional parameter "sourceSkuId": The sku_id of theexisting subscription to be upgraded or downgraded. This is required whenaction is SWITCH.

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

func (*SubscriptionsListCall)Context¶

func (c *SubscriptionsListCall) Context(ctxcontext.Context) *SubscriptionsListCall

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

func (*SubscriptionsListCall)CustomerAuthToken¶

func (c *SubscriptionsListCall) CustomerAuthToken(customerAuthTokenstring) *SubscriptionsListCall

CustomerAuthToken sets the optional parameter "customerAuthToken": The`customerAuthToken` query string is required when creating a resold accountthat transfers a direct customer's subscription or transfers anotherreseller customer's subscription to your reseller management. This is ahexadecimal authentication token needed to complete the subscriptiontransfer. For more information, see the administrator help center.

func (*SubscriptionsListCall)CustomerId¶

func (c *SubscriptionsListCall) CustomerId(customerIdstring) *SubscriptionsListCall

CustomerId sets the optional parameter "customerId": This can be either thecustomer's primary domain name or the customer's unique identifier. If thedomain name for a customer changes, the old domain name cannot be used toaccess the customer, but the customer's unique identifier (as returned bythe API) can always be used. We recommend storing the unique identifier inyour systems where applicable.

func (*SubscriptionsListCall)CustomerNamePrefix¶

func (c *SubscriptionsListCall) CustomerNamePrefix(customerNamePrefixstring) *SubscriptionsListCall

CustomerNamePrefix sets the optional parameter "customerNamePrefix": Whenretrieving all of your subscriptions and filtering for specific customers,you can enter a prefix for a customer name. Using an example customer groupthat includes `exam.com`, `example20.com` and `example.com`: - `exa` --Returns all customer names that start with 'exa' which could include`exam.com`, `example20.com`, and `example.com`. A name prefix is similar tousing a regular expression's asterisk, exa*. - `example` -- Returns`example20.com` and `example.com`.

func (*SubscriptionsListCall)Do¶

func (c *SubscriptionsListCall) Do(opts ...googleapi.CallOption) (*Subscriptions,error)

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

func (*SubscriptionsListCall)Fields¶

func (c *SubscriptionsListCall) Fields(s ...googleapi.Field) *SubscriptionsListCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SubscriptionsListCall)Header¶

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

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

func (*SubscriptionsListCall)IfNoneMatch¶

func (c *SubscriptionsListCall) IfNoneMatch(entityTagstring) *SubscriptionsListCall

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

func (*SubscriptionsListCall)MaxResults¶

func (c *SubscriptionsListCall) MaxResults(maxResultsint64) *SubscriptionsListCall

MaxResults sets the optional parameter "maxResults": When retrieving a largelist, the `maxResults` is the maximum number of results per page. The`nextPageToken` value takes you to the next page. The default is 20.

func (*SubscriptionsListCall)PageToken¶

func (c *SubscriptionsListCall) PageToken(pageTokenstring) *SubscriptionsListCall

PageToken sets the optional parameter "pageToken": Token to specify nextpage in the list

func (*SubscriptionsListCall)Pages¶

func (c *SubscriptionsListCall) Pages(ctxcontext.Context, f func(*Subscriptions)error)error

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 SubscriptionsService struct {// contains filtered or unexported fields}

funcNewSubscriptionsService¶

func NewSubscriptionsService(s *Service) *SubscriptionsService

func (*SubscriptionsService)Activate¶

func (r *SubscriptionsService) Activate(customerIdstring, subscriptionIdstring) *SubscriptionsActivateCall

Activate: Activates a subscription previously suspended by the reseller. Ifyou did not suspend the customer subscription and it is suspended for anyother reason, such as for abuse or a pending ToS acceptance, this call willnot reactivate the customer subscription.

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.
• subscriptionId: This is a required property. The `subscriptionId` is thesubscription identifier and is unique for each customer. Since a`subscriptionId` changes when a subscription is updated, we recommend tonot use this ID as a key for persistent data. And the `subscriptionId` canbe found using the retrieve all reseller subscriptions method.

func (*SubscriptionsService)ChangePlan¶

func (r *SubscriptionsService) ChangePlan(customerIdstring, subscriptionIdstring, changeplanrequest *ChangePlanRequest) *SubscriptionsChangePlanCall

ChangePlan: Updates a subscription plan. Use this method to update a planfor a 30-day trial or a flexible plan subscription to an annual commitmentplan with monthly or yearly payments. How a plan is updated differsdepending on the plan and the products. For more information, see thedescription in manage subscriptions(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#update_subscription_plan).

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.
• subscriptionId: This is a required property. The `subscriptionId` is thesubscription identifier and is unique for each customer. Since a`subscriptionId` changes when a subscription is updated, we recommend tonot use this ID as a key for persistent data. And the `subscriptionId` canbe found using the retrieve all reseller subscriptions method.

func (*SubscriptionsService)ChangeRenewalSettings¶

func (r *SubscriptionsService) ChangeRenewalSettings(customerIdstring, subscriptionIdstring, renewalsettings *RenewalSettings) *SubscriptionsChangeRenewalSettingsCall

ChangeRenewalSettings: Updates a user license's renewal settings. This isapplicable for accounts with annual commitment plans only. For moreinformation, see the description in manage subscriptions(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#update_renewal).

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.
• subscriptionId: This is a required property. The `subscriptionId` is thesubscription identifier and is unique for each customer. Since a`subscriptionId` changes when a subscription is updated, we recommend tonot use this ID as a key for persistent data. And the `subscriptionId` canbe found using the retrieve all reseller subscriptions method.

func (*SubscriptionsService)ChangeSeats¶

func (r *SubscriptionsService) ChangeSeats(customerIdstring, subscriptionIdstring, seats *Seats) *SubscriptionsChangeSeatsCall

ChangeSeats: Updates a subscription's user license settings. For moreinformation about updating an annual commitment plan or a flexible plansubscription’s licenses, see Manage Subscriptions(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#update_subscription_seat).

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.
• subscriptionId: This is a required property. The `subscriptionId` is thesubscription identifier and is unique for each customer. Since a`subscriptionId` changes when a subscription is updated, we recommend tonot use this ID as a key for persistent data. And the `subscriptionId` canbe found using the retrieve all reseller subscriptions method.

func (*SubscriptionsService)Delete¶

func (r *SubscriptionsService) Delete(customerIdstring, subscriptionIdstring, deletionTypestring) *SubscriptionsDeleteCall

Delete: Cancels, suspends, or transfers a subscription to direct.

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.
• deletionType: The `deletionType` query string enables the cancellation,downgrade, or suspension of a subscription.
• subscriptionId: This is a required property. The `subscriptionId` is thesubscription identifier and is unique for each customer. Since a`subscriptionId` changes when a subscription is updated, we recommend tonot use this ID as a key for persistent data. And the `subscriptionId` canbe found using the retrieve all reseller subscriptions method.

func (*SubscriptionsService)Get¶

func (r *SubscriptionsService) Get(customerIdstring, subscriptionIdstring) *SubscriptionsGetCall

Get: Gets a specific subscription. The `subscriptionId` can be found usingthe Retrieve all reseller subscriptions(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions)method. For more information about retrieving a specific subscription, seethe information descrived in manage subscriptions(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_subscription).

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.
• subscriptionId: This is a required property. The `subscriptionId` is thesubscription identifier and is unique for each customer. Since a`subscriptionId` changes when a subscription is updated, we recommend tonot use this ID as a key for persistent data. And the `subscriptionId` canbe found using the retrieve all reseller subscriptions method.

func (*SubscriptionsService)Insert¶

func (r *SubscriptionsService) Insert(customerIdstring, subscription *Subscription) *SubscriptionsInsertCall

Insert: Creates or transfer a subscription. Create a subscription for acustomer's account that you ordered using the Order a new customer account(https://developers.google.com/workspace/admin/reseller/v1/reference/customers/insert.html)method. For more information about creating a subscription for differentpayment plans, see manage subscriptions(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#create_subscription).\If you did not order the customer's account using the customer insertmethod, use the customer's `customerAuthToken` when creating a subscriptionfor that customer. If transferring a G Suite subscription with an associatedGoogle Drive or Google Vault subscription, use the batch operation(https://developers.google.com/workspace/admin/reseller/v1/how-tos/batch.html)to transfer all of these subscriptions. For more information, see how totransfer subscriptions(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#transfer_a_subscription).

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.

func (*SubscriptionsService)List¶

func (r *SubscriptionsService) List() *SubscriptionsListCall

List: Lists of subscriptions managed by the reseller. The list can be allsubscriptions, all of a customer's subscriptions, or all of a customer'stransferable subscriptions. Optionally, this method can filter the responseby a `customerNamePrefix`. For more information, see manage subscriptions(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions).

func (*SubscriptionsService)StartPaidService¶

func (r *SubscriptionsService) StartPaidService(customerIdstring, subscriptionIdstring) *SubscriptionsStartPaidServiceCall

StartPaidService: Immediately move a 30-day free trial subscription to apaid service subscription. This method is only applicable if a payment planhas already been set up for the 30-day trial subscription. For moreinformation, see manage subscriptions(https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#paid_service).

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.
• subscriptionId: This is a required property. The `subscriptionId` is thesubscription identifier and is unique for each customer. Since a`subscriptionId` changes when a subscription is updated, we recommend tonot use this ID as a key for persistent data. And the `subscriptionId` canbe found using the retrieve all reseller subscriptions method.

func (*SubscriptionsService)Suspend¶

func (r *SubscriptionsService) Suspend(customerIdstring, subscriptionIdstring) *SubscriptionsSuspendCall

Suspend: Suspends an active subscription. You can use this method to suspenda paid subscription that is currently in the `ACTIVE` state. * For`FLEXIBLE` subscriptions, billing is paused. * For `ANNUAL_MONTHLY_PAY` or`ANNUAL_YEARLY_PAY` subscriptions: * Suspending the subscription does notchange the renewal date that was originally committed to. * A suspendedsubscription does not renew. If you activate the subscription after theoriginal renewal date, a new annual subscription will be created, startingon the day of activation. We strongly encourage you to suspend subscriptionsonly for short periods of time as suspensions over 60 days may result in thesubscription being cancelled.

• customerId: This can be either the customer's primary domain name or thecustomer's unique identifier. If the domain name for a customer changes,the old domain name cannot be used to access the customer, but thecustomer's unique identifier (as returned by the API) can always be used.We recommend storing the unique identifier in your systems whereapplicable.
• subscriptionId: This is a required property. The `subscriptionId` is thesubscription identifier and is unique for each customer. Since a`subscriptionId` changes when a subscription is updated, we recommend tonot use this ID as a key for persistent data. And the `subscriptionId` canbe found using the retrieve all reseller subscriptions method.

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

func (*SubscriptionsStartPaidServiceCall)Context¶

func (c *SubscriptionsStartPaidServiceCall) Context(ctxcontext.Context) *SubscriptionsStartPaidServiceCall

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

func (*SubscriptionsStartPaidServiceCall)Do¶

func (c *SubscriptionsStartPaidServiceCall) Do(opts ...googleapi.CallOption) (*Subscription,error)

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

func (*SubscriptionsStartPaidServiceCall)Fields¶

func (c *SubscriptionsStartPaidServiceCall) Fields(s ...googleapi.Field) *SubscriptionsStartPaidServiceCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SubscriptionsStartPaidServiceCall)Header¶

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

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

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

func (*SubscriptionsSuspendCall)Context¶

func (c *SubscriptionsSuspendCall) Context(ctxcontext.Context) *SubscriptionsSuspendCall

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

func (*SubscriptionsSuspendCall)Do¶

func (c *SubscriptionsSuspendCall) Do(opts ...googleapi.CallOption) (*Subscription,error)

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

func (*SubscriptionsSuspendCall)Fields¶

func (c *SubscriptionsSuspendCall) Fields(s ...googleapi.Field) *SubscriptionsSuspendCall

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*SubscriptionsSuspendCall)Header¶

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

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