Activate a promotion code | Solvimon

curl -X POST https://test.api.solvimon.com/v1/promotion-codes//activate \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "code": "SUMMER2024",
  "coupon_id": "cpn_1234567890abcdef",
  "object_type": "promotion_code",
  "id": "pc_9a8b7c6d5e4f3a2b1c0d",
  "status": "ACTIVE",
  "limited_to": {
    "customer_ids": [
      "cus_9876543210fedcba"
    ],
    "customers": [
      {
        "reference": "REF-20231101-01",
        "type": "ORGANIZATION",
        "email": "contact@acmecorp.com",
        "roles": [
          "DEFAULT"
        ],
        "object_type": "customer",
        "id": "cus_9876543210fedcba",
        "created_at": "2023-11-01T10:15:30Z",
        "parent_customer_id": "cus_parent_001",
        "parent_customer_ids": [
          "cus_parent_001",
          "cus_grandparent_002"
        ],
        "status": "ACTIVE",
        "timezone": "America/New_York",
        "notification_preferences": [
          {
            "type": "INVOICE",
            "channels": [
              {
                "type": "EMAIL",
                "enabled": true
              }
            ]
          }
        ],
        "locale": "en-US",
        "individual": {
          "name": {
            "first_name": "John",
            "last_name": "Doe",
            "infix": ""
          },
          "residential_address": {
            "line1": "123 Maple Street",
            "line2": "Suite 400",
            "city": "Springfield",
            "postal_code": "01103",
            "state": "MA",
            "country": "US"
          }
        },
        "organization": {
          "legal_name": "Acme Corporation",
          "tax_id": "98-7654321",
          "tax_ids": [
            {
              "id": "TXID-001",
              "type": "EIN",
              "tax_id_validation_result": {
                "id": "val_001",
                "validation_date": "2024-05-01T12:00:00Z",
                "source": "IRS",
                "valid": "VALID",
                "message": "Tax ID verified successfully"
              }
            }
          ],
          "registration_number": "REG-2023-ACME",
          "tax_exempt": false,
          "tax_exempt_note": "",
          "registered_address": {
            "line1": "456 Industrial Way",
            "line2": "",
            "city": "Springfield",
            "postal_code": "01104",
            "state": "MA",
            "country": "US"
          },
          "tax_registrations": [
            {
              "id": "taxreg_001",
              "description": "State Sales Tax Registration",
              "tax_id": "ST-123456789",
              "tax_ids": [
                {
                  "id": "STID-001",
                  "type": "STATE_TAX_ID",
                  "tax_id_validation_result": {
                    "id": "val_002",
                    "validation_date": "2024-04-15T09:30:00Z",
                    "source": "State Department",
                    "valid": "VALID",
                    "message": "State tax ID is valid"
                  }
                }
              ],
              "registration_number": "ST-REG-2023-ACME",
              "registered_address": {
                "line1": "456 Industrial Way",
                "line2": "",
                "city": "Springfield",
                "postal_code": "01104",
                "state": "MA",
                "country": "US"
              }
            }
          ]
        },
        "custom_fields": [
          {
            "id": "cf_001",
            "reference": "preferred_contact_method",
            "value": "email",
            "values": [
              "email",
              "phone"
            ],
            "integration_details": {
              "payment_gateway_variant": "ADYEN",
              "id": "int_001",
              "reference": "payment_gateway_1",
              "adyen": {
                "recurring_detail_reference": "recurring_123456"
              },
              "stripe": {
                "payment_method_id": "pm_1GqIC8Lz0qyl6XeWl3a1b2c3"
              }
            }
          }
        ],
        "processing_only": false,
        "pricing_plan_subscription_selector": {
          "data": [
            {
              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
              "value": "US"
            }
          ],
          "rules": [
            {
              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
              "type": "EQUALS"
            }
          ],
          "filters": [
            {
              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
              "type": "EQUALS",
              "value": "US"
            }
          ],
          "fallback": "LATEST"
        },
        "linked_integrations": [
          {
            "id": "int_link_001",
            "link_details": [
              {
                "url": "https://dashboard.paymentgateway.com/account/12345",
                "custom_field_name": "payment_account"
              }
            ]
          }
        ]
      }
    ]
  },
  "start_at": "2024-06-01T00:00:00Z",
  "end_at": "2024-08-31T23:59:59Z",
  "maximum_redemptions": 1000,
  "number_of_redemptions": 250,
  "created_at": "2024-05-15T08:00:00Z",
  "updated_at": "2024-05-20T12:00:00Z"
}

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdOrReferencestringRequiredDefaults to

The ID or reference of the resource.

Response

codestring

coupon_idstring

object_typestring or nullRead-only

idstring or nullRead-only

statusenum or null

Allowed values:

limited_toobject

start_atstring or null

end_atstring or null

maximum_redemptionsinteger or null

number_of_redemptionsinteger or nullRead-only

created_atstring or nullRead-only

updated_atstring or nullRead-only

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors