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.

Scopes

You will need authorization for the openid scope to make a valid call.

If unset, the scope for this method defaults to openid. You can set the scope for this method like this: paymentsresellersubscription1 --scope <scope> partners subscriptions-provision ...

Required Scalar Argument

  • <parent> (string)
    • Required. The parent resource name, which is the identifier of the partner. It will have the format of "partners/{partner_id}".

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudPaymentsResellerSubscriptionV1Subscription:
  cancellation-details:
    reason: string
  create-time: string
  cycle-end-time: string
  end-user-entitled: boolean
  free-trial-end-time: string
  name: string
  partner-user-token: string
  processing-state: string
  products: [string]
  promotions: [string]
  redirect-uri: string
  renewal-time: string
  service-location:
    postal-code: string
    region-code: string
  state: string
  update-time: string
  upgrade-downgrade-details:
    billing-cycle-spec: string
    previous-subscription-id: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .cancellation-details reason=est

    • Output only. The reason of the cancellation.

  • .. create-time=ipsum

    • Output only. System generated timestamp when the subscription is created. UTC timezone.
  • cycle-end-time=ipsum
    • 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"
  • end-user-entitled=true
    • Output only. Indicates if the subscription is entitled to the end user.
  • free-trial-end-time=ea
    • 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.
  • name=dolor
    • 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.
  • partner-user-token=lorem
    • Required. Identifier of the end-user in partner’s system. The value is restricted to 63 ASCII characters at the maximum.
  • processing-state=eos
  • products=labore
    • 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}'.
    • Each invocation of this argument appends the given value to the array.
  • promotions=sed
    • 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}'.
    • Each invocation of this argument appends the given value to the array.
  • redirect-uri=duo
    • 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.
  • renewal-time=sed
    • 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"
  • service-location postal-code=no
    • The postal code this location refers to. Ex. "94043"

  • region-code=stet

    • 2-letter ISO region code for current content region. Ex. “US” Please refers to: https://en.wikipedia.org/wiki/ISO_3166-1

  • .. state=kasd

  • update-time=et
    • Output only. System generated timestamp when the subscription is most recently updated. UTC timezone.
  • upgrade-downgrade-details billing-cycle-spec=sed
    • Required. Specifies the billing cycle spec for the new upgraded/downgraded subscription.
  • previous-subscription-id=et
    • Required. The previous subscription id to be replaced. This is not the full resource name, use the subscription_id segment only.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p subscription-id=string
    • 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.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

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

  • -p key=string

    • 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.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • 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.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").