google_api_reseller v0.2.0 GoogleApi.Reseller.V1.Model.Subscription View Source

JSON template for a subscription.

Attributes

  • billingMethod (String.t): Read-only field that returns the current billing method for a subscription. Defaults to: null.
  • creationTime (String.t): The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter. Defaults to: null.
  • customerDomain (String.t): Primary domain name of the customer Defaults to: null.
  • customerId (String.t): 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. Defaults to: null.
  • dealCode (String.t): 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. Defaults to: null.
  • kind (String.t): Identifies the resource as a Subscription. Value: reseller#subscription Defaults to: null.
  • plan (SubscriptionPlan): Defaults to: null.
  • purchaseOrderId (String.t): 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. Defaults to: null.
  • renewalSettings (RenewalSettings): Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. Defaults to: null.
  • resourceUiUrl (String.t): 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. Defaults to: null.
  • seats (Seats): This is a required property. The number and limit of user seat licenses in the plan. Defaults to: null.
  • skuId (String.t): 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. Defaults to: null.
  • skuName (String.t): 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. Defaults to: null.
  • status (String.t): This is an optional property. Defaults to: null.
  • subscriptionId (String.t): 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. Defaults to: null.
  • suspensionReasons ([String.t]): 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). Defaults to: null.
  • transferInfo (SubscriptionTransferInfo): Defaults to: null.
  • trialSettings (SubscriptionTrialSettings): Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.Reseller.V1.Model.Subscription{
  billingMethod: any(),
  creationTime: any(),
  customerDomain: any(),
  customerId: any(),
  dealCode: any(),
  kind: any(),
  plan: GoogleApi.Reseller.V1.Model.SubscriptionPlan.t(),
  purchaseOrderId: any(),
  renewalSettings: GoogleApi.Reseller.V1.Model.RenewalSettings.t(),
  resourceUiUrl: any(),
  seats: GoogleApi.Reseller.V1.Model.Seats.t(),
  skuId: any(),
  skuName: any(),
  status: any(),
  subscriptionId: any(),
  suspensionReasons: [any()],
  transferInfo: GoogleApi.Reseller.V1.Model.SubscriptionTransferInfo.t(),
  trialSettings: GoogleApi.Reseller.V1.Model.SubscriptionTrialSettings.t()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.