---
title: "Retrieve the default payment instrument"
method: GET
path: "/billing/v1/paymentInstruments/default"
tags: ["PaymentInstrument"]
---

# Retrieve the default payment instrument

`GET /billing/v1/paymentInstruments/default`

## Request

- Base URL: `https://marketplace.appdirect.com/api`
- URL: `https://marketplace.appdirect.com/api/billing/v1/paymentInstruments/default`
- Auth: none declared
- TypeScript: <https://skmtc.dev/appdirect/apis/companies/docs/billing/v1/paymentInstruments/default/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve the default payment instrument for a given user and company

## Query parameters

- `companyUuid` string
- `userUuid` string

## Response `200`

OK

- PaymentInstrumentWS
  - `accountDisplay` string: Account display text.
  - `billingAddress` BillingAddressWS
    - `city` string, required: The name of the city or town
    - `country` string, required: The country code, in ISO-3166 format
    - `state` string: The state, province, or region
    - `firstName` string, required: The first name
    - `lastName` string, required: The last name
    - `phone` string, required: The phone number
    - `street1` string, required: The first line of a street address
    - `street2` string: The second line of a street address, for example, an apartment or office number
    - `zip` string, required: The ZIP or postal code of the address
    - `companyName` string: The name of the company
    - `fax` string: The fax number
    - `faxExtension` string: The fax extension number
    - `phoneExtension` string: The phone extension number
    - `poBox` string: The post office box number
    - `salutation` string: The title in a person's name, for example, Mr or Ms
  - `company` LinkWS, nullable
    - `href` string
    - `id` string
  - `createdOn` number: Payment instrument creation date.
  - `creditCard` CreditCardWS
    - `expirationMonth` number, required: Expiration month. Required field.
    - `expirationYear` number, required: Expiration year. Required field.
    - `name` string, required: Name as it appears on credit card. Required field.
    - `number` string, nullable, required: Credit card number. Required field.
    - `securityCode` string, nullable, required: Credit card security code. Required field.
    - `type` 'VISA' | 'MASTERCARD' | 'AMEX' | 'DISCOVER' | 'JCB' | 'GATEWAY'
  - `id` string: ID
  - `isDefault` boolean: True if this payment instrument is the default.
  - `paymentMethod` 'CREDIT_CARD' | 'PAYPAL' | 'MANUAL' | 'EXTERNAL_INVOICE' | 'MARKETPLACE_CREDITS': The supported payment methods
  - `user` LinkWS, nullable
    - `href` string
    - `id` string
  - `vatId` string: VAT ID.

## Other responses

- `404`: Not Found

## Changes

- **2026-11-06** `1fc240f06971`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/appdirect/apis/companies/changes/billing/v1/paymentInstruments/default/get.md)

---

[API](https://skmtc.dev/appdirect/apis/companies.md) - [All operations](https://skmtc.dev/appdirect/apis/companies/llms.txt) - [OpenAPI document](https://skmtc.dev/appdirect/apis/companies/revisions/1fc240f06971?raw)