Core API
- Checkout
- Checkout Links
- Custom Checkout Fields
- Customers
- Subscriptions
- Orders
- Discounts
- Refunds
- Products
- Benefits
- License Keys
- Files
- Organizations
- Metrics
Customer Portal API
- GETGet Customer
- GETGet Organization
- Sessions
- Subscriptions
- Orders
- License Keys
- File Downloads
Webhook Events
- Billing Events
- Organization Events
OAuth 2.0 API
- Connect
- Clients
List Orders
List orders.
package main
import(
"context"
"os"
polargo "github.com/polarsource/polar-go"
"github.com/polarsource/polar-go/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := polargo.New(
polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
)
res, err := s.Orders.List(ctx, operations.OrdersListRequest{})
if err != nil {
log.Fatal(err)
}
if res.ListResourceOrder != nil {
for {
// handle items
res, err = res.Next()
if err != nil {
// handle error
}
if res == nil {
break
}
}
}
}{
"items": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"custom_field_data": {},
"status": "<string>",
"amount": 123,
"tax_amount": 123,
"refunded_amount": 123,
"refunded_tax_amount": 123,
"currency": "<string>",
"billing_reason": "purchase",
"billing_address": {
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>"
},
"customer_id": "<string>",
"product_id": "<string>",
"product_price_id": "<string>",
"discount_id": "<string>",
"subscription_id": "<string>",
"checkout_id": "<string>",
"customer": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"email": "<string>",
"email_verified": true,
"name": "<string>",
"billing_address": {
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>"
},
"tax_id": [
"<any>"
],
"organization_id": "<string>",
"avatar_url": "<string>"
},
"user_id": "<string>",
"user": {
"id": "<string>",
"email": "<string>",
"public_name": "<string>",
"avatar_url": "<string>",
"github_username": "<string>"
},
"product": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "<string>"
},
"product_price": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"amount_type": "<string>",
"is_archived": true,
"product_id": "<string>",
"type": "<string>",
"recurring_interval": "month",
"price_currency": "<string>",
"price_amount": 123,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 123,
"currency": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"name": "<string>",
"code": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"max_redemptions": 123,
"redemptions_count": 123,
"organization_id": "<string>"
},
"subscription": {
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"amount": 123,
"currency": "<string>",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2023-11-07T05:31:56Z",
"current_period_end": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"canceled_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"product_id": "<string>",
"price_id": "<string>",
"discount_id": "<string>",
"checkout_id": "<string>",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "<string>",
"user_id": "<string>"
}
}
],
"pagination": {
"total_count": 123,
"max_page": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter by organization ID.
Filter by product ID.
Filter by product price type. recurring will return orders corresponding to subscriptions creations or renewals. one_time will return orders corresponding to one-time purchases.
one_time, recurring Filter by discount ID.
Filter by customer ID.
Filter by checkout ID.
Page number, defaults to 1.
x > 0Size of a page, defaults to 10. Maximum is 100.
x > 0Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
created_at, -created_at, amount, -amount, customer, -customer, product, -product, discount, -discount, subscription, -subscription Response
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Amount refunded
Sales tax refunded
purchase, subscription_create, subscription_cycle, subscription_update Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the product.
The name of the product.
The description of the product.
The recurring interval of the product. If None, the product is a one-time purchase.
month, year Whether the product is a subscription.
Whether the product is archived and no longer available.
The ID of the organization owning the product.
A recurring price for a product, i.e. a subscription.
Deprecated: The recurring interval should be set on the product itself.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the price.
"fixed"Whether the price is archived and no longer available.
The ID of the product owning the price.
The type of the price.
"recurring"The recurring interval of the price.
month, year The currency.
The price in cents.
once, forever, repeating fixed, percentage Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
Name of the discount. Will be displayed to the customer when the discount is applied.
Code customers can use to apply the discount during checkout.
Timestamp after which the discount is redeemable.
Timestamp after which the discount is no longer redeemable.
Maximum number of times the discount can be redeemed.
Number of times the discount has been redeemed.
The organization ID.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
month, year incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid customer_service, low_quality, missing_features, switched_service, too_complex, too_expensive, unused, other Was this page helpful?
package main
import(
"context"
"os"
polargo "github.com/polarsource/polar-go"
"github.com/polarsource/polar-go/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := polargo.New(
polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
)
res, err := s.Orders.List(ctx, operations.OrdersListRequest{})
if err != nil {
log.Fatal(err)
}
if res.ListResourceOrder != nil {
for {
// handle items
res, err = res.Next()
if err != nil {
// handle error
}
if res == nil {
break
}
}
}
}{
"items": [
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"custom_field_data": {},
"status": "<string>",
"amount": 123,
"tax_amount": 123,
"refunded_amount": 123,
"refunded_tax_amount": 123,
"currency": "<string>",
"billing_reason": "purchase",
"billing_address": {
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>"
},
"customer_id": "<string>",
"product_id": "<string>",
"product_price_id": "<string>",
"discount_id": "<string>",
"subscription_id": "<string>",
"checkout_id": "<string>",
"customer": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"email": "<string>",
"email_verified": true,
"name": "<string>",
"billing_address": {
"line1": "<string>",
"line2": "<string>",
"postal_code": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>"
},
"tax_id": [
"<any>"
],
"organization_id": "<string>",
"avatar_url": "<string>"
},
"user_id": "<string>",
"user": {
"id": "<string>",
"email": "<string>",
"public_name": "<string>",
"avatar_url": "<string>",
"github_username": "<string>"
},
"product": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"description": "<string>",
"recurring_interval": "month",
"is_recurring": true,
"is_archived": true,
"organization_id": "<string>"
},
"product_price": {
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"amount_type": "<string>",
"is_archived": true,
"product_id": "<string>",
"type": "<string>",
"recurring_interval": "month",
"price_currency": "<string>",
"price_amount": 123,
"legacy": true
},
"discount": {
"duration": "once",
"type": "fixed",
"amount": 123,
"currency": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"name": "<string>",
"code": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"max_redemptions": 123,
"redemptions_count": 123,
"organization_id": "<string>"
},
"subscription": {
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"amount": 123,
"currency": "<string>",
"recurring_interval": "month",
"status": "incomplete",
"current_period_start": "2023-11-07T05:31:56Z",
"current_period_end": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"canceled_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"customer_id": "<string>",
"product_id": "<string>",
"price_id": "<string>",
"discount_id": "<string>",
"checkout_id": "<string>",
"customer_cancellation_reason": "customer_service",
"customer_cancellation_comment": "<string>",
"user_id": "<string>"
}
}
],
"pagination": {
"total_count": 123,
"max_page": 123
}
}