Get the Stripe Billing Portal Link for a Customer

GET/customers/{customerId}/billing-portal/

API version

v2

Request method

GET

Operation ID

contributor-get-customer-billing-portal-link

---

Get the Stripe Billing Portal Link for a Customer.

Request

• customerIdstring (uuid)

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

Responses

Format

application/json

Description

The generated link to the Stripe Billing Portal

Schema documentation

• urlstring

Example

Content-Type: application/json

{
  "url": "string"
}

JSON Schema

{
  "properties": {
    "url": {
      "type": "string"
    }
  },
  "type": "object"
}

Usage examples

cURL

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

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.contributorGetCustomerBillingPortalLink({
  "customerId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ContributorGetCustomerBillingPortalLinkRequest(
  customerId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->marketplace()->contributorGetCustomerBillingPortalLink($request);

var_dump($response->getBody();