# POST /api/resellers/get-billing-preferences-async

Reads a reseller's billing preferences.

Available to an administrator, to a reseller reading its own record, and to a reseller
reading one it manages. Unlike the general read, this reaches the caller's own reseller
record, which the ordinary reseller listing does not return. Returns `null` when the
reseller has no billing preferences yet.

**Operation ID:** `resellersGetBillingPreferences`

## Authorization

Requires: Resellers.Resellers.Update, reseller scope.

Required permissions:
- `Resellers.Resellers.Update`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| resellerId | query | no | string(uuid) | The reseller to read. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `application/json`

Schema: `ResellerBillingPreferences`

Properties:
- `defaultPaymentTerms` (integer(int32)): Days until invoice due date (e.g. 30).
- `defaultCurrency` (string): ISO 4217 default currency for billing.
- `hppPageId` (string(uuid)): HPP page ID used for invoice payment links. Required: When DefaultFulfillmentPath == Invoicing and AllowOnlinePayment is true.
- `captureHppPageId` (string(uuid)): HPP page ID used to capture and store a card on file for the recurring-contract billing  path (the operator-driven payment-method capture flow). This must reference a  `SaveCard`-purpose page (zero-dollar verification, no charge) so capture does not  prompt the operator for an amount. Distinct from `hppPageId`, which is the  Invoicing payment-link page (a chargeable `Payment` page). Required: When DefaultFulfillmentPath == RecurringContract.
- `allowOnlinePayment` (boolean): Whether merchants can pay invoices online via HPP.
- `allowStoredPaymentMethods` (boolean): Whether merchants can store payment methods for billing.
- `autoChargeStoredMethod` (boolean): Auto-charge stored payment method after invoice generation.
- `autoBillingEnabled` (boolean): Whether automated billing runs are enabled.
- `billingPeriod` (integer(int32)): Billing period: 1=Monthly, 3=Quarterly.
- `billingDayOfMonth` (integer(int32)): Day of month for billing runs (1-28).
- `invoiceTemplateId` (string(uuid)): Invoice template ID (Phase 2: Invoicing module).
- `defaultTaxRateId` (string(uuid)): Default tax rate ID (Phase 2: Invoicing module).
- `sendInvoiceOnGeneration` (boolean): Auto-send invoice to merchant after generation.
- `billingRunNotificationEmail` (string): Admin notification email for billing run completions.
- `defaultFulfillmentPath` (object): Default fulfillment path for billing runs under this reseller. When null and a merchant  has no per-assignment override, the merchant is skipped with result status  `NoFulfillmentPath`.
- `collectionMerchantId` (string(uuid)): The reseller-owned billing entity that owns recurring contracts and vaults stored  payment methods. Required when `defaultFulfillmentPath` is  `RecurringContract`. This may be the reseller itself  or a designated child merchant; modeled internally as a single "MLB collection party"  reference so the legacy House Merchant flag is not reintroduced. Required: When DefaultFulfillmentPath == RecurringContract.
- `allowCardPayments` (boolean): Whether card tokens are permitted as stored payment methods for billed merchants.  Treated as `true` by callers when null on legacy documents.
- `allowAchPayments` (boolean): Whether ACH tokens are permitted as stored payment methods for billed merchants.  Treated as `true` by callers when null on legacy documents, matching  `allowCardPayments`: both are read permissively, rejecting only an explicit  `false`.

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/resellers/get-billing-preferences-async" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/resellers/get-billing-preferences-async' `
    -Headers $headers
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, ResellersApi } from '@winkpg/winkpg-api';

const api = new ResellersApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.resellersGetBillingPreferences();
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/resellers/get-billing-preferences-async', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new ResellersApi(config);
var result = await api.ResellersGetBillingPreferencesAsync();
```

### C# (raw HTTP)

```csharp
using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/resellers/get-billing-preferences-async");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.ResellersApi(client)
    result = api.resellers_get_billing_preferences()
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/resellers/get-billing-preferences-async",
    headers=headers,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.