APIs.io Engineering Platform User Billing Profile API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare User Billing Profile API
  version: 4.0.0
tags:
- name: User Billing Profile
paths:
  /user/billing/profile:
    get:
      deprecated: true
      description: Accesses your billing profile object.
      operationId: user-billing-profile-(-deprecated)-billing-profile-details
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bill-subs-api_billing_response_single'
                - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
          description: Billing Profile Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_billing_response_single'
          description: Billing Profile Details response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Billing Profile Details
      tags:
      - User Billing Profile
      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_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
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    bill-subs-api_api-response-single:
      allOf:
      - $ref: '#/components/schemas/bill-subs-api_api-response-common'
      - properties:
          result:
            anyOf:
            - type:
              - object
              - 'null'
            - type:
              - string
              - 'null'
      type: object
    bill-subs-api_billing_response_single:
      allOf:
      - $ref: '#/components/schemas/bill-subs-api_api-response-single'
      - properties:
          result:
            properties:
              account_type:
                example: type
                type: string
              address:
                example: 123 Main Street
                type: string
              address2:
                example: Apt 1
                type: string
              balance:
                example: 0
                type: string
              card_expiry_month:
                example: 12
                type: integer
              card_expiry_year:
                example: 2099
                type: integer
              card_number:
                example: 4242424242424242.0
                type: string
              city:
                example: Anytown
                type: string
              company:
                example: Company
                type: string
              country:
                example: Anycountry
                type: string
              created_on:
                example: '2014-03-01T12:21:59.3456Z'
                format: date-time
                type: string
              device_data:
                example: sample_data
                type: string
              edited_on:
                example: '2014-03-01T12:21:59.3456Z'
                format: date-time
                type: string
              enterprise_billing_email:
                example: johndoe@gmail.com
                type: string
              enterprise_primary_email:
                example: johndoe@gmail.com
                type: string
              first_name:
                example: John
                type: string
              id:
                $ref: '#/components/schemas/bill-subs-api_components-schemas-identifier'
              is_partner:
                example: false
                type: boolean
              last_name:
                example: Doe
                type: string
              next_bill_date:
                example: '2014-03-01T12:21:59.3456Z'
                format: date-time
                type: string
              payment_address:
                example: 123 Main Street
                type: string
              payment_address2:
                example: Apt 1
                type: string
              payment_city:
                example: Anytown
                type: string
              payment_country:
                example: Anycountry
                type: string
              payment_email:
                example: johndoe@gmail.com
                type: string
              payment_first_name:
                example: John
                type: string
              payment_gateway:
                example: gateway
                type: string
              payment_last_name:
                example: Doe
                type: string
              payment_nonce:
                example: abc123
                type: string
              payment_state:
                example: state
                type: string
              payment_zipcode:
                example: 12345
                type: string
              primary_email:
                example: johndoe@gmail.com
                type: string
              state:
                example: AnyState
                type: string
              tax_id_type:
                example: type
                type: string
              telephone:
                example: 1234567899.0
                type: string
              use_legacy:
                example: false
                type: boolean
              validation_code:
                example: 1111
                type: string
              vat:
                example: GB123456789
                type: string
              zipcode:
                example: 12345
                type: string
            type: object
        type: object
    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_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
    bill-subs-api_components-schemas-identifier:
      description: Billing item identifier tag.
      example: b69a9f3492637782896352daae219e7d
      maxLength: 32
      readOnly: true
      type: string
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey