Core API
- Checkout
- Checkout Links
- Custom Checkout Fields
- Customers
- Subscriptions
- Orders
- Discounts
- Refunds
- Products
- Events
- Meters
- Benefits
- Customer Meters
- License Keys
- Files
- Organizations
- Metrics
Customer Portal API
- GETGet Customer
- GETGet Organization
- Sessions
- Subscriptions
- Orders
- License Keys
- File Downloads
Webhook Events
- Customer Events
- Billing Events
- Organization Events
OAuth 2.0 API
- Connect
- Clients
Refunds
Create Refund
Create a refund.
Scopes: refunds:write
POST
/
v1
/
refunds
package main
import(
"context"
"os"
polargo "github.com/polarsource/polar-go"
"github.com/polarsource/polar-go/models/components"
"log"
)
func main() {
ctx := context.Background()
s := polargo.New(
polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
)
res, err := s.Refunds.Create(ctx, components.RefundCreate{
OrderID: "<value>",
Reason: components.RefundReasonCustomerRequest,
Amount: 90,
})
if err != nil {
log.Fatal(err)
}
if res.Refund != nil {
// handle response
}
}
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"status": "pending",
"reason": "duplicate",
"amount": 123,
"tax_amount": 123,
"currency": "<string>",
"organization_id": "<string>",
"order_id": "<string>",
"subscription_id": "<string>",
"customer_id": "<string>",
"revoke_benefits": true
}
Authorizations
You can generate an Organization Access Token from your organization's settings.
Body
application/json
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
package main
import(
"context"
"os"
polargo "github.com/polarsource/polar-go"
"github.com/polarsource/polar-go/models/components"
"log"
)
func main() {
ctx := context.Background()
s := polargo.New(
polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
)
res, err := s.Refunds.Create(ctx, components.RefundCreate{
OrderID: "<value>",
Reason: components.RefundReasonCustomerRequest,
Amount: 90,
})
if err != nil {
log.Fatal(err)
}
if res.Refund != nil {
// handle response
}
}
{
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"metadata": {},
"status": "pending",
"reason": "duplicate",
"amount": 123,
"tax_amount": 123,
"currency": "<string>",
"organization_id": "<string>",
"order_id": "<string>",
"subscription_id": "<string>",
"customer_id": "<string>",
"revoke_benefits": true
}
Assistant
Responses are generated using AI and may contain mistakes.