openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 User Billing History API
description:
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: User Billing History paths: /user/billing/history: get: deprecated: true description: Accesses your billing history object. operationId: user-billing-history-(-deprecated)-billing-history-details parameters: - in: query name: page schema: default: 1 description: Page number of paginated results. minimum: 1 type: number - in: query name: per_page schema: default: 20 description: Number of items per page. maximum: 50 minimum: 5 type: number - in: query name: order schema: description: Field to order billing history by. enum: - type - occurred_at - action example: occurred_at type: string - in: query name: occurred_at schema: $ref: '#/components/schemas/bill-subs-api_occurred_at' - in: query name: type schema: description: The billing item type. example: charge maxLength: 30 readOnly: true type: string - in: query name: action schema: description: The billing item action. example: subscription maxLength: 30 readOnly: true type: string responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/bill-subs-api_billing_history_collection' - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure' description: Billing History Details response failure '200': content: application/json: schema: $ref: '#/components/schemas/bill-subs-api_billing_history_collection' description: Billing History Details response security: - api_email: [] api_key: [] api_token: [] summary: APIs.io Engineering Platform Billing History Details tags: - User Billing History x-api-token-group: - Billing Write - Billing Read x-cfPermissionsRequired: enum: - '#billing:read' x-cfPlanAvailability: business: true enterprise: true free: true pro: true components: schemas: bill-subs-api_action: description: The billing item action. example: subscription maxLength: 30 readOnly: true type: string bill-subs-api_type: description: The billing item type. example: charge maxLength: 30 readOnly: true type: string bill-subs-api_messages: example: [] items: properties: code: minimum: 1000 type: integer message: type: string required: - code - message type: object uniqueItems: true type: array bill-subs-api_result_info: properties: count: description: Total number of results for the requested service example: 1 type: number page: description: Current page within paginated list of results example: 1 type: number per_page: description: Number of results per page of results example: 20 type: number total_count: description: Total results available without any search parameters example: 2000 type: number type: object bill-subs-api_billing_history_collection: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-collection' - properties: result: items: $ref: '#/components/schemas/bill-subs-api_billing-history' type: array bill-subs-api_occurred_at: description: When the billing item was created. example: '2014-03-01T12:21:59.3456Z' format: date-time readOnly: true type: string bill-subs-api_api-response-collection: allOf: - $ref: '#/components/schemas/bill-subs-api_api-response-common' - properties: result: items: {} nullable: true type: array result_info: $ref: '#/components/schemas/bill-subs-api_result_info' type: object bill-subs-api_schemas-zone: properties: name: readOnly: true type: string type: object bill-subs-api_billing-history: properties: action: $ref: '#/components/schemas/bill-subs-api_action' amount: $ref: '#/components/schemas/bill-subs-api_amount' currency: $ref: '#/components/schemas/bill-subs-api_currency' description: $ref: '#/components/schemas/bill-subs-api_description' id: $ref: '#/components/schemas/bill-subs-api_components-schemas-identifier' occurred_at: $ref: '#/components/schemas/bill-subs-api_occurred_at' type: $ref: '#/components/schemas/bill-subs-api_type' zone: $ref: '#/components/schemas/bill-subs-api_schemas-zone' required: - id - type - action - description - occurred_at - amount - currency - zone type: object bill-subs-api_description: description: The billing item description. example: The billing item description maxLength: 255 readOnly: true type: string bill-subs-api_api-response-common-failure: properties: errors: allOf: - $ref: '#/components/schemas/bill-subs-api_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/bill-subs-api_messages' example: [] result: enum: - null nullable: true type: object success: description: Whether the API call was successful enum: - false example: false type: boolean required: - success - errors - messages - result type: object bill-subs-api_components-schemas-identifier: description: Billing item identifier tag. example: b69a9f3492637782896352daae219e7d maxLength: 32 readOnly: true type: string bill-subs-api_currency: description: The monetary unit in which pricing information is displayed. example: USD readOnly: true type: string bill-subs-api_amount: description: The amount associated with this billing item. example: 20.99 readOnly: true type: number bill-subs-api_api-response-common: properties: errors: $ref: '#/components/schemas/bill-subs-api_messages' messages: $ref: '#/components/schemas/bill-subs-api_messages' result: anyOf: - type: object - items: {} type: array - type: string success: description: Whether the API call was successful enum: - true example: true type: boolean required: - success - errors - messages - result type: object securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true