LogoLogo
  • Piriod API
  • Getting started
  • Integrations flows
  • Authentication
  • Error Handling
  • Pagination and Filtering
  • Core Resources
    • Customers
      • Create a customer
      • List customers
    • Contacts
    • Reminders
  • Billing
    • Products
    • Plans
    • Addons
    • Coupons
    • Subscriptions
    • Usages
    • Invoices
    • Credit Notes
    • Orders
  • Payments
    • Sources
    • Payments
  • Apps
    • Customer Base
      • Sessions
  • Collections
    • Documents
    • Currencies
    • Countries
    • States
Powered by GitBook
On this page
  • State object
  • List states

Was this helpful?

  1. Collections

States

Represents a state belonging to a physical address. This object is used by the Customer API.

PreviousCountries

Last updated 3 years ago

Was this helpful?

State object

Attributes

id string

Unique object's identifier.

code string

ISO or local code determined.

country string

Country ID the state belongs to.

name string

Name of the state.

{
    "id": "US-CA",
    "code": "CA",
    "country": "US",
    "name": "California"
}

See the available in Piriod

List states

GET https://api.piriod.com/generals/states/

Lists states objects. Learn more about pagination and filtering.

Query Parameters

Name
Type
Description

country

string

ID string of a particular country or multiple countries (using __in filter operator)

name

string

Exact or snippet of the currency name (using __exact, __contains or __icontains operators)

{
  "count": 26,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "US-CA",
      "code": "CA",
      "country": "US",
      "name": "California",
    },
    {
      "id": "US-NC",
      "code": "NC",
      "country": "US",
      "name": "Carolina del Norte"
    },
    ...
    ...
    ...
    {
      "id": "US-OH",
      "code": "OH",
      "country": "US",
      "name": "Ohio"
    },
    {
      "id": "US-OK",
      "code": "OK",
      "country": "US",
      "name": "Oklahoma"
    }
  ]
}
complete list of states