Stripe

Endpoints:

  • GET /v1/Organizations/:id/stripe
  • POST /v1/Organizations/:id/stripe
  • GET /v1/Organizations/:id/stripe/count
  • DELETE /v1/Stripe/:id
  • PATCH /v1/Stripe/:id

The Stripe object

Parameters

  • id string readonly

  • name string

    Name of account for user's own identification

  • apiKey string

  • active boolean

  • autoSend boolean

    If invoice should be sent to customer automatically upon creation

  • lang string

  • invoiceAction string

    Action to listen for issuing invoices. Defaults to first received if not set.

  • businessPremiseId string

  • electronicDeviceId string

  • autoTaxClassification string

    If set, will automatically classify tax for invoice items. Possible values: 'standard' (default), reduced', 'zero', 'none' or custom.

  • organizationId string

  • accountId string

  • unitId string

    • Additional propertiesExpand all 
    
      {
  "name": "string",
  "apiKey": "string",
  "active": true,
  "autoSend": true,
  "lang": "string",
  "invoiceAction": "string",
  "businessPremiseId": "string",
  "electronicDeviceId": "string",
  "autoTaxClassification": "standard",
  "id": "string",
  "organizationId": "string",
  "createdAt": "2022-04-20T10:10:30+00:00Z",
  "updatedAt": "2022-04-20T10:10:30+00:00Z",
  "accountId": "string",
  "unitId": "string"
}

Find Stripes

GET /v1/Organizations/:id/stripe

Parameters

Path

  • id string required

    Organization id

Query

  • filter string optional 

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/stripe', {
  method: 'GET',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  }
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X GET https://api.spaceinvoices.com/v1/Organizations/{id}/stripe \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/stripe'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)

Your access token displayed in examples.

Response:

    
      [
  {
    "name": "string",
    "apiKey": "string",
    "active": true,
    "autoSend": true,
    "lang": "string",
    "invoiceAction": "string",
    "businessPremiseId": "string",
    "electronicDeviceId": "string",
    "autoTaxClassification": "standard",
    "id": "string",
    "organizationId": "string",
    "createdAt": "2022-04-20T10:10:30+00:00Z",
    "updatedAt": "2022-04-20T10:10:30+00:00Z",
    "accountId": "string",
    "unitId": "string"
  }
]

Create Stripe

POST /v1/Organizations/:id/stripe

Parameters

Path

  • id string required

    Organization id

Properties

  • name string required

    Name of account for user's own identification

  • active boolean required

    Default is: true

  • autoSend boolean required

    Default is: true

    If invoice should be sent to customer automatically upon creation

  • apiKey string optional

  • lang string optional

  • invoiceAction string optional

    Action to listen for issuing invoices. Defaults to first received if not set.

  • businessPremiseId string optional

  • electronicDeviceId string optional

  • autoTaxClassification string optional

    Default is: standard

    If set, will automatically classify tax for invoice items. Possible values: 'standard' (default), reduced', 'zero', 'none' or custom.

  • organizationId string optional

  • accountId string optional

  • unitId string optional 

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/stripe', {
  method: 'POST',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    name: 'string',
    apiKey: 'string',
    active: true,
    autoSend: true,
    lang: 'string',
    invoiceAction: 'string',
    businessPremiseId: 'string',
    electronicDeviceId: 'string',
    autoTaxClassification: 'standard',
    organizationId: 'string',
    accountId: 'string',
    unitId: 'string'
  })
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X POST https://api.spaceinvoices.com/v1/Organizations/{id}/stripe \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string", \
    "apiKey": "string", \
    "active": true, \
    "autoSend": true, \
    "lang": "string", \
    "invoiceAction": "string", \
    "businessPremiseId": "string", \
    "electronicDeviceId": "string", \
    "autoTaxClassification": "standard", \
    "organizationId": "string", \
    "accountId": "string", \
    "unitId": "string"
  }'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/stripe'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
params = {
  'name': 'string',
  'apiKey': 'string',
  'active': True,
  'autoSend': True,
  'lang': 'string',
  'invoiceAction': 'string',
  'businessPremiseId': 'string',
  'electronicDeviceId': 'string',
  'autoTaxClassification': 'standard',
  'organizationId': 'string',
  'accountId': 'string',
  'unitId': 'string'
}
response = requests.post(url, json=params, headers=headers)

Your access token displayed in examples.

Response:

    
      {
  "name": "string",
  "apiKey": "string",
  "active": true,
  "autoSend": true,
  "lang": "string",
  "invoiceAction": "string",
  "businessPremiseId": "string",
  "electronicDeviceId": "string",
  "autoTaxClassification": "standard",
  "id": "string",
  "organizationId": "string",
  "createdAt": "2022-04-20T10:10:30+00:00Z",
  "updatedAt": "2022-04-20T10:10:30+00:00Z",
  "accountId": "string",
  "unitId": "string"
}

Count Stripes

GET /v1/Organizations/:id/stripe/count

Parameters

Path

  • id string required

    Organization id

Query

  • where string optional

    Criteria to match model instances

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Organizations/{id}/stripe/count', {
  method: 'GET',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  }
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X GET https://api.spaceinvoices.com/v1/Organizations/{id}/stripe/count \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Organizations/{id}/stripe/count'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
response = requests.get(url, params={}, headers=headers)

Your access token displayed in examples.

Response:

    
      {
  "count": 42
}

Delete Stripe

DELETE /v1/Stripe/:id

Parameters

Path

  • id string required

    Model id

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Stripe/{id}', {
  method: 'DELETE',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  }
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X DELETE https://api.spaceinvoices.com/v1/Stripe/{id} \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Stripe/{id}'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
response = requests.delete(url, params={}, headers=headers)

Your access token displayed in examples.

Response:

    
      {
  "count": 1
}

Patch Stripe

PATCH /v1/Stripe/:id

Parameters

Path

  • id string required

    Stripe id

Properties

  • name string required

    Name of account for user's own identification

  • active boolean required

    Default is: true

  • autoSend boolean required

    Default is: true

    If invoice should be sent to customer automatically upon creation

  • apiKey string optional

  • lang string optional

  • invoiceAction string optional

    Action to listen for issuing invoices. Defaults to first received if not set.

  • businessPremiseId string optional

  • electronicDeviceId string optional

  • autoTaxClassification string optional

    Default is: standard

    If set, will automatically classify tax for invoice items. Possible values: 'standard' (default), reduced', 'zero', 'none' or custom.

  • organizationId string optional

  • accountId string optional

  • unitId string optional 

      
        const response = await fetch('https://api.spaceinvoices.com/v1/Stripe/{id}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'ACCESS_TOKEN',
    'content-type': 'application/json'
  },
  body: JSON.stringify({
    name: 'string',
    apiKey: 'string',
    active: true,
    autoSend: true,
    lang: 'string',
    invoiceAction: 'string',
    businessPremiseId: 'string',
    electronicDeviceId: 'string',
    autoTaxClassification: 'standard',
    organizationId: 'string',
    accountId: 'string',
    unitId: 'string'
  })
});

Your access token is displayed in examples.

Prerequisite: npm install node-fetch

        
          curl -X PATCH https://api.spaceinvoices.com/v1/Stripe/{id} \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string", \
    "apiKey": "string", \
    "active": true, \
    "autoSend": true, \
    "lang": "string", \
    "invoiceAction": "string", \
    "businessPremiseId": "string", \
    "electronicDeviceId": "string", \
    "autoTaxClassification": "standard", \
    "organizationId": "string", \
    "accountId": "string", \
    "unitId": "string"
  }'

Your access token displayed in examples.

        
          import requests
url = 'https://api.spaceinvoices.com/v1/Stripe/{id}'
headers = {
  'Authorization': 'ACCESS_TOKEN',
  'content-type': 'application/json',
}
params = {
  'name': 'string',
  'apiKey': 'string',
  'active': True,
  'autoSend': True,
  'lang': 'string',
  'invoiceAction': 'string',
  'businessPremiseId': 'string',
  'electronicDeviceId': 'string',
  'autoTaxClassification': 'standard',
  'organizationId': 'string',
  'accountId': 'string',
  'unitId': 'string'
}
response = requests.patch(url, json=params, headers=headers)

Your access token displayed in examples.

Response:

    
      {
  "name": "string",
  "apiKey": "string",
  "active": true,
  "autoSend": true,
  "lang": "string",
  "invoiceAction": "string",
  "businessPremiseId": "string",
  "electronicDeviceId": "string",
  "autoTaxClassification": "standard",
  "id": "string",
  "organizationId": "string",
  "createdAt": "2022-04-20T10:10:30+00:00Z",
  "updatedAt": "2022-04-20T10:10:30+00:00Z",
  "accountId": "string",
  "unitId": "string"
}