1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.developers.html">developers</a> . <a href="apigee_v1.organizations.developers.subscriptions.html">subscriptions</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a subscription to an API product. </p> 83<p class="toc_element"> 84 <code><a href="#expire">expire(name, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Expires an API product subscription immediately.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets details for an API product subscription.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, count=None, startKey=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists all API product subscriptions for a developer.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 100 <pre>Creates a subscription to an API product. 101 102Args: 103 parent: string, Required. Email address of the developer that is purchasing a subscription to the API product. Use the following structure in your request: `organizations/{org}/developers/{developer_email}` (required) 104 body: object, The request body. 105 The object takes the form of: 106 107{ # Structure of a DeveloperSubscription. 108 "apiproduct": "A String", # Name of the API product for which the developer is purchasing a subscription. 109 "createdAt": "A String", # Output only. Time when the API product subscription was created in milliseconds since epoch. 110 "endTime": "A String", # Time when the API product subscription ends in milliseconds since epoch. 111 "lastModifiedAt": "A String", # Output only. Time when the API product subscription was last modified in milliseconds since epoch. 112 "name": "A String", # Output only. Name of the API product subscription. 113 "startTime": "A String", # Time when the API product subscription starts in milliseconds since epoch. 114} 115 116 x__xgafv: string, V1 error format. 117 Allowed values 118 1 - v1 error format 119 2 - v2 error format 120 121Returns: 122 An object of the form: 123 124 { # Structure of a DeveloperSubscription. 125 "apiproduct": "A String", # Name of the API product for which the developer is purchasing a subscription. 126 "createdAt": "A String", # Output only. Time when the API product subscription was created in milliseconds since epoch. 127 "endTime": "A String", # Time when the API product subscription ends in milliseconds since epoch. 128 "lastModifiedAt": "A String", # Output only. Time when the API product subscription was last modified in milliseconds since epoch. 129 "name": "A String", # Output only. Name of the API product subscription. 130 "startTime": "A String", # Time when the API product subscription starts in milliseconds since epoch. 131}</pre> 132</div> 133 134<div class="method"> 135 <code class="details" id="expire">expire(name, body=None, x__xgafv=None)</code> 136 <pre>Expires an API product subscription immediately. 137 138Args: 139 name: string, Required. Name of the API product subscription. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/subscriptions/{subscription}` (required) 140 body: object, The request body. 141 The object takes the form of: 142 143{ # Request for ExpireDeveloperSubscription. 144} 145 146 x__xgafv: string, V1 error format. 147 Allowed values 148 1 - v1 error format 149 2 - v2 error format 150 151Returns: 152 An object of the form: 153 154 { # Structure of a DeveloperSubscription. 155 "apiproduct": "A String", # Name of the API product for which the developer is purchasing a subscription. 156 "createdAt": "A String", # Output only. Time when the API product subscription was created in milliseconds since epoch. 157 "endTime": "A String", # Time when the API product subscription ends in milliseconds since epoch. 158 "lastModifiedAt": "A String", # Output only. Time when the API product subscription was last modified in milliseconds since epoch. 159 "name": "A String", # Output only. Name of the API product subscription. 160 "startTime": "A String", # Time when the API product subscription starts in milliseconds since epoch. 161}</pre> 162</div> 163 164<div class="method"> 165 <code class="details" id="get">get(name, x__xgafv=None)</code> 166 <pre>Gets details for an API product subscription. 167 168Args: 169 name: string, Required. Name of the API product subscription. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/subscriptions/{subscription}` (required) 170 x__xgafv: string, V1 error format. 171 Allowed values 172 1 - v1 error format 173 2 - v2 error format 174 175Returns: 176 An object of the form: 177 178 { # Structure of a DeveloperSubscription. 179 "apiproduct": "A String", # Name of the API product for which the developer is purchasing a subscription. 180 "createdAt": "A String", # Output only. Time when the API product subscription was created in milliseconds since epoch. 181 "endTime": "A String", # Time when the API product subscription ends in milliseconds since epoch. 182 "lastModifiedAt": "A String", # Output only. Time when the API product subscription was last modified in milliseconds since epoch. 183 "name": "A String", # Output only. Name of the API product subscription. 184 "startTime": "A String", # Time when the API product subscription starts in milliseconds since epoch. 185}</pre> 186</div> 187 188<div class="method"> 189 <code class="details" id="list">list(parent, count=None, startKey=None, x__xgafv=None)</code> 190 <pre>Lists all API product subscriptions for a developer. 191 192Args: 193 parent: string, Required. Email address of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}` (required) 194 count: integer, Number of API product subscriptions to return in the API call. Use with `startKey` to provide more targeted filtering. Defaults to 100. The maximum limit is 1000. 195 startKey: string, Name of the API product subscription from which to start displaying the list of subscriptions. If omitted, the list starts from the first item. For example, to view the API product subscriptions from 51-150, set the value of `startKey` to the name of the 51st subscription and set the value of `count` to 100. 196 x__xgafv: string, V1 error format. 197 Allowed values 198 1 - v1 error format 199 2 - v2 error format 200 201Returns: 202 An object of the form: 203 204 { # Response for ListDeveloperSubscriptions. 205 "developerSubscriptions": [ # List of all subscriptions. 206 { # Structure of a DeveloperSubscription. 207 "apiproduct": "A String", # Name of the API product for which the developer is purchasing a subscription. 208 "createdAt": "A String", # Output only. Time when the API product subscription was created in milliseconds since epoch. 209 "endTime": "A String", # Time when the API product subscription ends in milliseconds since epoch. 210 "lastModifiedAt": "A String", # Output only. Time when the API product subscription was last modified in milliseconds since epoch. 211 "name": "A String", # Output only. Name of the API product subscription. 212 "startTime": "A String", # Time when the API product subscription starts in milliseconds since epoch. 213 }, 214 ], 215 "nextStartKey": "A 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. 216}</pre> 217</div> 218 219</body></html>