Cobot Membership Plan API

openapi: 3.2.0
info:
  title: Cobot Membership Plan API
  termsOfService: https://www.cobot.me/terms
  x-logo:
    url: /api2_logo.webp
    backgroundColor: '#FFFFFF'
    altText: Cobot logo
  description: This is the 2.0 version of the Cobot API.
  version: '2.0'
  contact:
    name: Cobot Support
    url: https://dev.cobot.me/
    email: support@cobot.me
servers:
- url: https://api.cobot.me
security:
- OAuth2: []
tags:
- name: Membership Plan
  description: 'The plans belonging to a membership. When a membership is signed up one of the

    space''s plans is selected and a copy is created for the membership.

    A membership''s plan can be customized or changed over time, creating a new

    membership plan object every time.'
paths:
  /spaces/{spaceId}/membership_plans:
    get:
      summary: For space
      description: 'Get the plan history for the given time

        and for each membership that was active during the given time.


        Data is returned as a flat list of membership plans.

        Each plan has a relationship pointing to the membership it belongs to

        and startsAt/canceledAt attributes to determine the time it was active.


        **Access**: The current user must be an admin of the space or any

        space in the network.'
      operationId: get-space-membership-plans
      parameters:
      - name: spaceId
        in: path
        description: Id of the space.
        required: true
        schema:
          type: string
      - name: filter[from]
        in: query
        description: Only return membership plans that have been active from the given date on.
        required: true
        schema:
          type: string
          format: date
        example: '2020-04-20'
      - name: filter[to]
        in: query
        description: Only return membership plans that have been active until the given date.
        required: true
        schema:
          type: string
          format: date
        example: '2020-04-20'
      security:
      - OAuth2:
        - read_memberships
      tags:
      - Membership Plan
      responses:
        '200':
          description: 'Returns a list of membership plans.

            '
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/membership-plans'
              examples:
                default:
                  value:
                    data:
                    - id: 12a99a71ac8da98d29de357189d273c6
                      type: membershipPlans
                      attributes:
                        accountingCode: P1
                        canceledAt: null
                        cycleDuration: 1
                        description: Our most popular plan!
                        extras:
                        - accountingCode: PE1
                          cycleDuration: 6
                          name: Keys
                          pricePerCycle:
                            net: '50.0'
                            gross: '58.5'
                            currency: EUR
                            taxes:
                            - rate: '19.0'
                              name: VAT
                        name: Basic Plan
                        pricePerCycle:
                          net: '100.0'
                          gross: '119.0'
                          currency: EUR
                          taxes:
                          - rate: '19.0'
                            name: VAT
                        startsAt: '2020-04-20'
                      relationships:
                        membership:
                          data:
                            id: a8c12f62ac8df98d29de357180d673e1
                            type: memberships
components:
  schemas:
    decimal:
      description: A decimal number.
      type: string
      pattern: ^-?\d+(\.\d+)?$
    membership-plans:
      id: membership-plans.json#
      type: object
      required:
      - data
      additionalProperties: false
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/-membership-plan-data'
        links:
          type: object
        meta:
          $ref: '#/components/schemas/pagination-meta'
    linkage:
      description: The "type" and "id" of a linked entity.
      type: object
      required:
      - type
      - id
      properties:
        type:
          type: string
        id:
          type: string
      additionalProperties: false
    currency:
      description: ISO 4217 3 letter currency code.
      type: string
      pattern: ^[A-Z]{3}$
    -membership-plan-extra-data:
      id: -membership-plan-extra-data.json
      type: object
      additionalProperties: false
      required:
      - accountingCode
      - cycleDuration
      - name
      - pricePerCycle
      properties:
        accountingCode:
          oneOf:
          - type: 'null'
          - type: string
        cycleDuration:
          type: number
          minimum: 1
        name:
          type: string
        pricePerCycle:
          $ref: '#/components/schemas/price'
    pagination-meta:
      type: object
      additionalProperties: false
      properties:
        totalPages:
          type: number
        currentPage:
          type: number
    -membership-plan-data:
      id: -membership-plan-data.json
      type: object
      required:
      - id
      - type
      additionalProperties: false
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - membershipPlans
        attributes:
          type: object
          required:
          - accountingCode
          - cycleDuration
          - name
          - pricePerCycle
          - startsAt
          - extras
          - description
          additionalProperties: false
          properties:
            accountingCode:
              oneOf:
              - type: 'null'
              - type: string
            canceledAt:
              description: The date of the last day the plan was active or null if it is still active
              oneOf:
              - type: 'null'
              - $ref: '#/components/schemas/date'
            cycleDuration:
              description: For how many months this plan is billed at once, i.e. a cycle duration of 2 means the member is billed every 2 months the plans' price.
              type: number
              minimum: 1
            description:
              oneOf:
              - type: 'null'
              - type: string
            extras:
              description: Any extras that were added to this memberships' plan. Are billed along the plan.
              type: array
              items:
                $ref: '#/components/schemas/-membership-plan-extra-data'
            name:
              type: string
            pricePerCycle:
              $ref: '#/components/schemas/price'
            startsAt:
              $ref: '#/components/schemas/date'
        relationships:
          type: object
          additionalProperties: false
          properties:
            membership:
              description: The membership this plan belongs to
              type: object
              additionalProperties: false
              properties:
                data:
                  $ref: '#/components/schemas/linkage'
    date:
      description: A date in the form YYYY-MM-DD.
      type: string
      pattern: ^\d{4}-\d{2}-\d{2}$
    price:
      description: Price including net/gross value and all taxes.
      type: object
      required:
      - net
      - gross
      - currency
      - taxes
      additionalProperties: false
      properties:
        net:
          $ref: '#/components/schemas/decimal'
        gross:
          $ref: '#/components/schemas/decimal'
        currency:
          $ref: '#/components/schemas/currency'
        taxes:
          type: array
          items:
            $ref: '#/components/schemas/tax'
    tax:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
        rate:
          $ref: '#/components/schemas/decimal'
        amount:
          $ref: '#/components/schemas/decimal'
  securitySchemes:
    OpenId:
      type: openIdConnect
      openIdConnectUrl: https://www.cobot.me/.well-known/openid-configuration
    OAuth2:
      type: oauth2
      description: "OAuth is \"an open protocol to allow secure API authorization in a simple and\nstandard method from desktop and web applications.\". \"OAuth 2.0 is the\nnext evolution of the OAuth protocol [..]. OAuth 2.0 focuses on client\ndeveloper simplicity [...]. It is supported by many popular sites such as\nFacebook and there are client libraries available for many programming\nlanguages.\n\nFor information about OAuth2 see the [oauth website](http://oauth.net/2/).\n\n**For OAuth2 you need a client id and secret. In order to get those you have\nto [register your application](/oauth2_clients).**\n\nAPI authorization works by passing a bearer token via the HTTP Authorization header:\n\n    Authorization: bearer <token>\n\n## Permissions (Scope)\n\nOAuth2 [defines scopes](https://tools.ietf.org/html/rfc6749#section-3.3) to\nrestrict access to certain resources.\n\nThe required scope for each resource can be found within the documentation\nfor each endpoint.\n\nPlease note that a user's scope can be limited when they access the API as\nan admin of a space and some of their admin permissions have been revoked.\n"
      flows:
        authorizationCode:
          authorizationUrl: https://www.cobot.me/oauth/authorize
          tokenUrl: https://www.cobot.me/oauth/access_token
          scopes:
            read_articles: Read help desk articles.
            read_allocations: Read resource allocation data.
            read_booking_credits: Read information about a membership's booking credits.
            read_bookings: Read booking data.
            read_built_in_email_customizations: Read built in email customizations.
            read_calendar_blockers: Read calendar blockers.
            read_check_ins: Read memberships' check-in data.
            read_contacts: Read contacts.
            read_drop_in_passes: Read drop-in passes.
            read_drop_in_pass_templates: Read drop-in pass templates.
            read_discount_codes: Read discount codes.
            read_event_attendances: Read who is attending an event.
            read_event_messages: Read messages sent about events.
            read_events: Read events of a space.
            read_external_bookings: Read external booking data.
            read_external_resources: Read resources enabled for external booking.
            read_invoices: Read invoices created for a membership in a space.
            read_memberships: Read information about memberships in a space.
            read_teams: Read information about teams in a space.
            read_membership_profiles: Read members' profile data.
            read_navigation_links: Read/list navigation links for a space.
            read_payment_methods: Read payment methods in order to process payments.
            read_published_membership_profiles: Read published members' profile data.
            read_networks: Read information about a network.
            read_products: Read information about products.
            read_resource_categories: Read information about booking calendar categories.
            read_resources: Read information about booking calendar resources.
            read_single_page_apps: Read information about single page apps.
            read_space_profiles: Read space profile information.
            read_spaces: Read basic space information.
            read_space_billing_details: Read information relevant to billing the space.
            read_space_payment_method: Read a space's payment method used to pay for the space's Cobot subscription.
            read_space_subscriptions: Read a space's subscription.
            read_terms_approvals: Shows missing approvals for the current member.
            read_urls: Read the URLs to the Cobot web interface.
            read_user: Read the current user's information.
            write_bookings: Write booking data.
            write_check_ins: Check a member in at a space.
            write_customers: Convert a space to a customer.
            write_drop_in_pass_purchases: Create drop-in pass purchases.
            write_drop_in_passes: Cancel drop-in passes.
            write_event_ticket_purchases: Create event ticket purchases.
            write_event_attendances: Attend/unattend events.
            write_event_messages: Create/update messages sent about events.
            write_events: Write to events of a space.
            write_external_bookings: Create/update bookings as a non-member.
            write_external_resources: Create/update/delete resources enabled for non-memberss
            write_resources: Create/update/delete booking calendar resources.
            write_invoices: Create invoices for members in a space.
            write_invoice_reminders: Send invoice reminder emails.
            write_membership_profiles: Manage the social profiles of members.
            write_navigation_links: Create/update/delete navigation links for a space.
            write_payments: Initiate payments for external bookings.
            write_single_page_apps: Create and update single page apps to be embedded on Cobot.
            write_space_billing_details: Update a space's billing details.
            write_space_payment_method: Update a space's payment method used to pay for the space's Cobot subscription.
            write_space_subscriptions: Change a space's subscription. Only trusted clients can request this scope. Contact support.
            write_terms_approvals: Approve different kinds of terms as a member.