Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks
Sandboxes

Retrieve a service action v2

Retrieve a Service Action object.

Learn more about calling API v2 endpoints.

Parameters

  • idstringRequired

    The ID of the Service Action.

Returns

Response attributes

  • idstring

    Unique identifier for the object.

  • objectstring, value is "v2.billing.service_action"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • createdtimestamp

    Timestamp of when the object was created.

  • credit_grantnullable object

    Details for the credit grant. Provided only if type is “credit_grant”.

  • credit_grant_per_tenantnullable objectPreview feature

    Details for the credit grant per tenant. Provided only if type is “credit_grant_per_tenant”.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • lookup_keynullable string

    An internal key you can use to search for this service action.

  • service_intervalenum

    The interval for assessing service.

    Possible enum values
    day

    Assess service by days.

    month

    Assess service by months.

    week

    Assess service by weeks.

    year

    Assess service by years.

  • service_interval_countinteger

    The length of the interval for assessing service.

  • typeenum

    The type of the service action.

    Possible enum values
    credit_grant

    The service action is of type credit_grant.

    credit_grant_per_tenant

    The service action is of type credit_grant_per_tenant.

Error Codes
404service_action_not_found

Returned by ServiceAction API when the service action is not found.

GET /v2/billing/service_actions/:id
curl https://api.stripe.com/v2/billing/service_actions/svca_test_61T4uYa7twTnFzqS316Ss95I3tSQSib3S1PC0IDCSPQe \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-08-27.preview"
Response
{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "svca_test_61T4uYa7twTnFzqS316Ss95I3tSQSib3S1PC0IDCSPQe",
  "lookup_key": "sample_service_action",
  "object": "v2.billing.service_action",
  "service_interval": "month",
  "service_interval_count": 1,
  "type": "credit_grant",
  "livemode": false,
  "credit_grant": {
    "amount": {
      "type": "monetary",
      "monetary": {
        "currency": "usd",
        "value": "1000"
      }
    },
    "applicability_config": {
      "scope": {
        "price_type": "metered"
      }
    },
    "expiry_config": {
      "type": "end_of_service_period"
    },
    "name": "Sample Credit Grant"
  }
}

Rate Cards v2

A Rate Card describes usage-based pricing. To bill a customer using a Rate Card, create a Rate Card Subscription which links it to the corresponding Billing Cadence.

Learn more about calling API v2 endpoints.
Endpoints

Rate Card Subscriptions v2

A Rate Card Subscription links a Rate Card to a specific Billing Cadence. While the rate card subscription is active, Stripe will bill the payer according to the rate card’s pricing.

Learn more about calling API v2 endpoints.
Endpoints

Pricing Plans v2

A Pricing Plan describes a collection of pricing components that can be used to bill customers. To bill a customer using a Pricing Plan, create a Pricing Plan Subscription which links it to the corresponding Billing Cadence.

Learn more about calling API v2 endpoints.
Endpoints

Pricing Plan Subscriptions v2

A Pricing Plan Subscription links a Pricing Plan to a specific Billing Cadence. While the pricing plan subscription is active, Stripe will bill the payer according to the pricing plan’s components.

Learn more about calling API v2 endpoints.
Endpoints