openapi: 3.0.3
info:
title: Gencove Back array billing API
version: v2
contact:
email: support@gencove.com
license:
name: Proprietary
description: API for Gencove REST service. Visit <a href='https://enterprise.gencove.com/'>enterprise.gencove.com</a> and <a href='https://docs.gencove.com/'>docs.gencove.com</a> for more information. <br><hr><p>To work with Insomnia, you can generate a Gencove API key by <a target='_blank' href='https://web.gencove.com/account?filter=api-keys'>clicking here</a>. Once you have the API key and have imported the project in Insomnia as a <i>Request Collection</i>, enter the key in Insomnia under <i>Manage Environment</i>.</p><a href='https://insomnia.rest/run/?label=back_api2&uri=https%3A%2F%2Fv2-api-files-prod.s3.amazonaws.com%2Fpublic%2Finsomnia%2Finsomnia_gencove_prod.json' target='_blank'>Run in Insomnia</a><hr>
servers:
- url: https://api.gencove.com
tags:
- name: billing
paths:
/api/v2/billing-portal/:
post:
operationId: billing_portal_create
description: Retrieve currently logged in user's Stripe customer portal url.
tags:
- billing
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BillingPortal'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BillingPortal'
multipart/form-data:
schema:
$ref: '#/components/schemas/BillingPortal'
security:
- JWT: []
- API key: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/BillingPortal'
description: ''
components:
schemas:
BillingPortal:
type: object
properties:
billing_portal_url:
type: string
format: uri
readOnly: true
description: Billing portal URL to go to.
required:
- billing_portal_url
securitySchemes:
API key:
type: apiKey
description: 'Authorization header content formated as: `Api-Key <API-key>`
You can obtain new API key through Gencove''s web UI or `user-api-key` endpoint'
in: header
name: Authorization
JWT:
type: apiKey
description: 'Authorization header content formated as: `Bearer <json-web-token>`
You can obtain access token using `jwt-create` endpoint.'
in: header
name: Authorization