subscriptions

Creates, updates, deletes, gets or lists a subscriptions resource.

Overview

Name	subscriptions
Type	Resource
Id	google.apigee.subscriptions

Fields

The following fields are returned by SELECT queries:

organizations_appgroups_subscriptions_get

Name	Datatype	Description
name	string	Output only. Name of the API product subscription.
apiproduct	string	Required. Name of the API product for which the appgroup is purchasing a subscription.
createdAt	string (int64)	Output only. Time when the API product subscription was created in milliseconds since epoch.
endTime	string (int64)	Output only. Time when the API product subscription ends in milliseconds since epoch.
lastModifiedAt	string (int64)	Output only. Time when the API product subscription was last modified in milliseconds since epoch.
startTime	string (int64)	Output only. Time when the API product subscription starts in milliseconds since epoch.

organizations_developers_subscriptions_get

Name	Datatype	Description
name	string	Output only. Name of the API product subscription.
apiproduct	string	Name of the API product for which the developer is purchasing a subscription.
createdAt	string (int64)	Output only. Time when the API product subscription was created in milliseconds since epoch.
endTime	string (int64)	Time when the API product subscription ends in milliseconds since epoch.
lastModifiedAt	string (int64)	Output only. Time when the API product subscription was last modified in milliseconds since epoch.
startTime	string (int64)	Time when the API product subscription starts in milliseconds since epoch.

organizations_appgroups_subscriptions_list

Name	Datatype	Description
name	string	Output only. Name of the API product subscription.
apiproduct	string	Required. Name of the API product for which the appgroup is purchasing a subscription.
createdAt	string (int64)	Output only. Time when the API product subscription was created in milliseconds since epoch.
endTime	string (int64)	Output only. Time when the API product subscription ends in milliseconds since epoch.
lastModifiedAt	string (int64)	Output only. Time when the API product subscription was last modified in milliseconds since epoch.
startTime	string (int64)	Output only. Time when the API product subscription starts in milliseconds since epoch.

organizations_developers_subscriptions_list

Name	Datatype	Description
developerSubscriptions	array	List of all subscriptions.
nextStartKey	string	Value that can be sent as startKey to retrieve the next page of content. If this field is omitted, there are no subsequent pages.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_appgroups_subscriptions_get	select	organizationsId, appgroupsId, subscriptionsId		Get an api product subscription for an appgroup.
organizations_developers_subscriptions_get	select	organizationsId, developersId, subscriptionsId		Gets details for an API product subscription.
organizations_appgroups_subscriptions_list	select	organizationsId, appgroupsId	pageSize, pageToken	List all api product subscriptions for an appgroup.
organizations_developers_subscriptions_list	select	organizationsId, developersId	count, startKey	Lists all API product subscriptions for a developer.
organizations_appgroups_subscriptions_create	insert	organizationsId, appgroupsId		Creates a subscription to an API product.
organizations_developers_subscriptions_create	insert	organizationsId, developersId		Creates a subscription to an API product.
organizations_appgroups_subscriptions_expire	exec	organizationsId, appgroupsId, subscriptionsId		Expires an API product subscription immediately.
organizations_developers_subscriptions_expire	exec	organizationsId, developersId, subscriptionsId		Expires an API product subscription immediately.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
appgroupsId	string
developersId	string
organizationsId	string
subscriptionsId	string
count	integer (int32)
pageSize	integer (int32)
pageToken	string
startKey	string

SELECT examples

organizations_appgroups_subscriptions_get

Get an api product subscription for an appgroup.

SELECT
name,
apiproduct,
createdAt,
endTime,
lastModifiedAt,
startTime
FROM google.apigee.subscriptions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND appgroupsId = '{{ appgroupsId }}' -- required
AND subscriptionsId = '{{ subscriptionsId }}' -- required
;

organizations_developers_subscriptions_get

Gets details for an API product subscription.

SELECT
name,
apiproduct,
createdAt,
endTime,
lastModifiedAt,
startTime
FROM google.apigee.subscriptions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND developersId = '{{ developersId }}' -- required
AND subscriptionsId = '{{ subscriptionsId }}' -- required
;

organizations_appgroups_subscriptions_list

List all api product subscriptions for an appgroup.

SELECT
name,
apiproduct,
createdAt,
endTime,
lastModifiedAt,
startTime
FROM google.apigee.subscriptions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND appgroupsId = '{{ appgroupsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

organizations_developers_subscriptions_list

Lists all API product subscriptions for a developer.

SELECT
developerSubscriptions,
nextStartKey
FROM google.apigee.subscriptions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND developersId = '{{ developersId }}' -- required
AND count = '{{ count }}'
AND startKey = '{{ startKey }}'
;

INSERT examples

organizations_appgroups_subscriptions_create

Creates a subscription to an API product.

INSERT INTO google.apigee.subscriptions (
data__apiproduct,
organizationsId,
appgroupsId
)
SELECT 
'{{ apiproduct }}',
'{{ organizationsId }}',
'{{ appgroupsId }}'
RETURNING
name,
apiproduct,
createdAt,
endTime,
lastModifiedAt,
startTime
;

organizations_developers_subscriptions_create

Creates a subscription to an API product.

INSERT INTO google.apigee.subscriptions (
data__apiproduct,
data__endTime,
data__startTime,
organizationsId,
developersId
)
SELECT 
'{{ apiproduct }}',
'{{ endTime }}',
'{{ startTime }}',
'{{ organizationsId }}',
'{{ developersId }}'
RETURNING
name,
apiproduct,
createdAt,
endTime,
lastModifiedAt,
startTime
;

Manifest

# Description fields are for documentation purposes
- name: subscriptions
props:
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the subscriptions resource.
  - name: appgroupsId
    value: "{{ appgroupsId }}"
    description: Required parameter for the subscriptions resource.
  - name: developersId
    value: "{{ developersId }}"
    description: Required parameter for the subscriptions resource.
  - name: apiproduct
    value: "{{ apiproduct }}"
    description: |
      Name of the API product for which the developer is purchasing a subscription.
  - name: endTime
    value: "{{ endTime }}"
    description: |
      Time when the API product subscription ends in milliseconds since epoch.
  - name: startTime
    value: "{{ startTime }}"
    description: |
      Time when the API product subscription starts in milliseconds since epoch.

Lifecycle Methods

organizations_appgroups_subscriptions_expire

Expires an API product subscription immediately.

EXEC google.apigee.subscriptions.organizations_appgroups_subscriptions_expire 
@organizationsId='{{ organizationsId }}' --required, 
@appgroupsId='{{ appgroupsId }}' --required, 
@subscriptionsId='{{ subscriptionsId }}' --required
;

organizations_developers_subscriptions_expire

Expires an API product subscription immediately.

EXEC google.apigee.subscriptions.organizations_developers_subscriptions_expire 
@organizationsId='{{ organizationsId }}' --required, 
@developersId='{{ developersId }}' --required, 
@subscriptionsId='{{ subscriptionsId }}' --required
;