Get contributor Billing Information

GET/contributors/{contributorId}/billing-information/

API version

v2

Request method

GET

Operation ID

contributor-get-billing-information

---

Request

• contributorIdstring (uuid)

  required
  Example:"907a24e9-0723-4566-b584-86578419e983"

Responses

Format

application/json

Description

The billing related information of the Contributor

Schema documentation

• contributorIdstring (uuid)
• invoiceFooterstring
• onboardingStatusstring (one of: NOT_STARTED, STARTED, SUCCESSFUL)
• stripeAccountIdstring

Example

Content-Type: application/json

{
  "contributorId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "invoiceFooter": "string",
  "onboardingStatus": "NOT_STARTED",
  "stripeAccountId": "string"
}

JSON Schema

{
  "properties": {
    "contributorId": {
      "format": "uuid",
      "type": "string"
    },
    "invoiceFooter": {
      "type": "string"
    },
    "onboardingStatus": {
      "enum": [
        "NOT_STARTED",
        "STARTED",
        "SUCCESSFUL"
      ],
      "type": "string"
    },
    "stripeAccountId": {
      "type": "string"
    }
  },
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contributors/f0f86186-0a5a-45b2-aa33-502777496347/billing-information

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.contributorGetBillingInformation({
  "contributorId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ContributorGetBillingInformation\ContributorGetBillingInformationRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ContributorGetBillingInformationRequest(
  contributorId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->marketplace()->contributorGetBillingInformation($request);

var_dump($response->getBody();