Enterprise Apps Reseller API v1

Version: 5.3

Enterprise Apps Reseller API v1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you create and manage your customers and their subscriptions. Google documentation.

(require gapi/macro)

(require-gapi-doc reseller.v1.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 subscriptions

procedure
(reseller-subscriptions-list
[ #:maxResults maxResults
#:pageToken pageToken
#:customerNamePrefix customerNamePrefix
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  customerNamePrefix : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Lists subscriptions of a reseller, optionally filtered by a customer name prefix.

maxResults: Maximum number of results to return

pageToken: Token to specify next page in the list

customerNamePrefix: Prefix of the customer’s domain name by which the subscriptions should be filtered. Optional

procedure
(reseller-subscriptions-get #:customerId customerId
#:subscriptionId subscriptionId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  customerId : string?
  subscriptionId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Gets a subscription of the customer.

customerId: Id of the Customer

subscriptionId: Id of the subscription, which is unique for a customer

procedure
(reseller-subscriptions-insert
#:customerId customerId
[ #:customerAuthToken customerAuthToken
#:kind kind
#:purchaseOrderId purchaseOrderId
#:seats seats
#:creationTime creationTime
#:plan plan
#:renewalSettings renewalSettings
#:skuId skuId
#:subscriptionId subscriptionId
#:trialSettings trialSettings
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  customerId : string?
  customerAuthToken : string? = 'N/A
  kind : string? = 'N/A
  purchaseOrderId : string? = 'N/A
  seats : string? = 'N/A
  creationTime : string? = 'N/A
  plan : string? = 'N/A
  renewalSettings : string? = 'N/A
  skuId : string? = 'N/A
  subscriptionId : string? = 'N/A
  trialSettings : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Creates/Transfers a subscription for the customer.

customerId: Id of the Customer

customerAuthToken: An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken. Optional.

kind: Identifies the resource as a Subscription.

purchaseOrderId: Purchase order id for your order tracking purposes.

seats: Number/Limit of seats in the new plan.

creationTime: Creation time of this subscription in milliseconds since Unix epoch.

plan: Plan details of the subscription

renewalSettings: Renewal settings of the subscription.

skuId: Name of the sku for which this subscription is purchased.

subscriptionId: The id of the subscription.

trialSettings: Trial Settings of the subscription.

procedure
(reseller-subscriptions-changePlan
#:customerId customerId
#:subscriptionId subscriptionId
[ #:kind kind
#:planName planName
#:purchaseOrderId purchaseOrderId
#:seats seats
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  customerId : string?
  subscriptionId : string?
  kind : string? = 'N/A
  planName : string? = 'N/A
  purchaseOrderId : string? = 'N/A
  seats : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Changes the plan of a subscription

customerId: Id of the Customer

subscriptionId: Id of the subscription, which is unique for a customer

kind: Identifies the resource as a subscription change plan request.

planName: Name of the plan to change to.

purchaseOrderId: Purchase order id for your order tracking purposes.

seats: Number/Limit of seats in the new plan.

procedure
(reseller-subscriptions-changeRenewalSettings
#:customerId customerId
#:subscriptionId subscriptionId
[ #:kind kind
#:renewalType renewalType
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  customerId : string?
  subscriptionId : string?
  kind : string? = 'N/A
  renewalType : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Changes the renewal settings of a subscription

customerId: Id of the Customer

subscriptionId: Id of the subscription, which is unique for a customer

kind: Identifies the resource as a subscription renewal setting.

renewalType: Subscription renewal type.

procedure
(reseller-subscriptions-changeSeats
#:customerId customerId
#:subscriptionId subscriptionId
[ #:kind kind
#:maximumNumberOfSeats maximumNumberOfSeats
#:numberOfSeats numberOfSeats
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  customerId : string?
  subscriptionId : string?
  kind : string? = 'N/A
  maximumNumberOfSeats : string? = 'N/A
  numberOfSeats : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Changes the seats configuration of a subscription

customerId: Id of the Customer

subscriptionId: Id of the subscription, which is unique for a customer

kind: Identifies the resource as a subscription change plan request.

maximumNumberOfSeats: Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.

numberOfSeats: Number of seats to purchase. This is applicable only for a commitment plan.

procedure
(reseller-subscriptions-startPaidService
#:customerId customerId
#:subscriptionId subscriptionId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  customerId : string?
  subscriptionId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Starts paid service of a trial subscription

customerId: Id of the Customer

subscriptionId: Id of the subscription, which is unique for a customer

procedure
(reseller-subscriptions-delete
#:customerId customerId
#:subscriptionId subscriptionId
#:deletionType deletionType
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  customerId : string?
  subscriptionId : string?
  deletionType : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Cancels/Downgrades a subscription.

customerId: Id of the Customer

subscriptionId: Id of the subscription, which is unique for a customer

deletionType: Whether the subscription is to be fully cancelled or downgraded

2.2 customers

procedure
(reseller-customers-get #:customerId customerId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  customerId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Gets a customer resource if one exists and is owned by the reseller.

customerId: Id of the Customer

procedure
(reseller-customers-insert
[ #:customerAuthToken customerAuthToken
#:kind kind
#:alternateEmail alternateEmail
#:customerDomain customerDomain
#:customerId customerId
#:phoneNumber phoneNumber
#:postalAddress postalAddress
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  customerAuthToken : string? = 'N/A
  kind : string? = 'N/A
  alternateEmail : string? = 'N/A
  customerDomain : string? = 'N/A
  customerId : string? = 'N/A
  phoneNumber : string? = 'N/A
  postalAddress : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Creates a customer resource if one does not already exist.

customerAuthToken: An auth token needed for inserting a customer for which domain already exists. Can be generated at https://www.google.com/a/cpanel//TransferToken. Optional.

kind: Identifies the resource as a customer.

alternateEmail: The alternate email of the customer.

customerDomain: The domain name of the customer.

customerId: The id of the customer.

phoneNumber: The phone number of the customer.

postalAddress: The postal address of the customer.

procedure
(reseller-customers-patch #:customerId customerId
[ #:kind kind
#:alternateEmail alternateEmail
#:customerDomain customerDomain
#:phoneNumber phoneNumber
#:postalAddress postalAddress
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  customerId : string?
  kind : string? = 'N/A
  alternateEmail : string? = 'N/A
  customerDomain : string? = 'N/A
  phoneNumber : string? = 'N/A
  postalAddress : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Update a customer resource if one it exists and is owned by the reseller. This method supports patch semantics.

customerId: Id of the Customer

kind: Identifies the resource as a customer.

alternateEmail: The alternate email of the customer.

customerDomain: The domain name of the customer.

phoneNumber: The phone number of the customer.

postalAddress: The postal address of the customer.

procedure
(reseller-customers-update #:customerId customerId
[ #:kind kind
#:alternateEmail alternateEmail
#:customerDomain customerDomain
#:phoneNumber phoneNumber
#:postalAddress postalAddress
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  customerId : string?
  kind : string? = 'N/A
  alternateEmail : string? = 'N/A
  customerDomain : string? = 'N/A
  phoneNumber : string? = 'N/A
  postalAddress : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Update a customer resource if one it exists and is owned by the reseller.

customerId: Id of the Customer

kind: Identifies the resource as a customer.

alternateEmail: The alternate email of the customer.

customerDomain: The domain name of the customer.

phoneNumber: The phone number of the customer.

postalAddress: The postal address of the customer.